mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-21 11:50:42 +00:00
VariableVince
eca5794ebb
## Description:
Only mentioning removals/major updates/notable changes below, not all
minor upgrades.
### Removed:
- "@aws-sdk/client-s3": not used anywhere (was used in Archive.ts
previously)
- chai, "@types/chai", sinon-chai: not used anywhere, probably leftover.
Vitest uses a bundled version of Chai for its expect asserations under
the hood too.
- protobufjs, "@types/google-protobuf": not used anywhere, probably left
from evan's experiment with it? Removed from vite.config.ts too.
- "@types/jquery": not used anywhere, probably leftover
- sinon, "@types/sinon": not used anywhere just like chai, probably
leftover. And Vitest provides us with the same functionality.
- "@types/systeminformation": dependency systeminformation was removed
last year, this is an unneeded, deprecated and unmaintained remainder.
- vite-tsconfig-paths: removed, and removed the import and usage in
vite.config.ts and replaced it by adding `tsconfigPaths: true` to the
`resolve` block. Because of this message displayed on running the tests:
"The plugin "vite-tsconfig-paths" is detected. Vite now supports
tsconfig paths resolution natively via the resolve.tsconfigPaths option.
You can remove the plugin and set resolve.tsconfigPaths: true in your
Vite config instead."
- vite-plugin-static-copy: removed, we don't use it anymore (was used in
our vite.config.ts once,, probably before Vite natively supported
copying static assets via its publicDir configuration)
### Updated:
- color.js: v0.5 > v0.6, no breaking change affecting us
- cross-env: v7 > v10. It's a publicly archived repo since Nov 2025. But
before that he got it up-to-date from June 2025, porting to TS, dropping
old Node versions, dependencies etc. Seems still good to use for some
amount of time to come.
- dotenv: v16 > v17, now logs an informational message by default when
it loads an environment file. Can be disabled by using
dotenv.config({quite: true}) if needed.
- ejs: v3 > v5: security patches mostly. Vite still uses v3 btw.
- eslint: v9 > v10. Newly enabled rules by default:
'no-unassigned-vars', 'no-useless-assignment' and
'preserve-caught-error'. Mostly faster and minimum support moved to
higher node versions, which shouldn't be a problem.
- "@eslint/compat": v1 > v2. Minimum supported Node versions, which
should not be a problem.
- intl-messageformat: v10 > v11 no breaking changes that affect us
- jdom: v27 > v29. Faster. Most notably minimum support moved to higher
node v22 version, which should not be a problem. Also, see types/node,
kind of expecting v24 to be installed now.
- nanoid: from v3 to v5, no breaking changes that affect us
- "@opentelemetry/sdk-logs": now that addLogRecordProcessor is removed,
changed Logger.ts to pass an (empty) provider array directly to the
LoggerProvider constructor. Follows the changes in
https://github.com/open-telemetry/opentelemetry-js/pull/5588
- "@tailwindcss/vite": supports vite v8 from 4.2.2, and a fix for it in
4.2.4
- tailwindcss: supports vite v8 from 4.2.2
-- in 4.1.15 (we were already above this version) break-words was
deprecated in favor of wrap-break-word. But break-words, which we use in
15 places, will still work as expected
(https://github.com/tailwindlabs/tailwindcss/pull/19157). Same goes for
also deprecated "order-none".
- "@types/node": from v22 to v24, assuming most now use node 24
- vite v7 > v8:
-- is now on 8.0.10 so first bugs are out of it, while v8 itself also
fixed a big number of bugs.
-- in vite.config.ts, fixed Ts error/compilation issue by changing the
manualChunks option in build.rollupOptions.output to use the function
syntax, which is required by the updated types instead of the object
syntax.
- zod: no changes that affect us
### Prettier:
Updated only because of (new because of update?) Prettier errors for
files untouched in this PR originally:
- PathFinder.Parabola.ts
- WorkerMessages.ts
- ClanModal.handlers.test.ts
- ClanModal.rendering.test.ts
- CONTRIBUTING.md
- README.md
### ESLint:
Fixes needed to silence errors coming from newly enabled recommended
rules 'no-useless-assignment' and 'preserve-caught-error':
For 'no-useless-assignment' (default assignment never used because of
unreachable code or they are guaranteed to get a value, so they can be
undefinedat the start. Exception was AttackExecution, so made the
default value of 0 the default case in the switch statement):
- ClientGameRunner
- GameModeSelector
- NameBoxCalculator
- StructureDrawingUtils
- TerritoryLayer
- Diagnostics
- GameRunner
- ColorAllocator
- DefaultConfig
- AttackExecution
- AiAttackBehavior
- Worker.worker
- GamePreviewBuilder
For 'preserve-caught-error', disabled the rule here because the possible
fix `{cause: error}` was introduced in ES2022 while we're still on
target ES2020 currently:
- GameServer
- Privilege
_Error: The value assigned to 'gameMap' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'timeDisplay' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'scalingFactor' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'radius' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'teamColor' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'gl' is not used in subsequent statements.
(no-useless-assignment)
Error: The value assigned to 'power' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'tickExecutionDuration' is not used in
subsequent statements. (no-useless-assignment)
Error: The value assigned to 'selectedIndex' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'mag' is not used in subsequent statements.
(no-useless-assignment)
Error: The value assigned to 'speed' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'matchesCriteria' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'shouldContinue' is not used in subsequent
statements. (no-useless-assignment)
Error: The value assigned to 'description' is not used in subsequent
statements. (no-useless-assignment)
Error: There is no `cause` attached to the symptom error being thrown.
(preserve-caught-error)
Error: There is no `cause` attached to the symptom error being thrown.
(preserve-caught-error)_
All tests pass. TypeScript and ESLint errors resolved.
## Please complete the following:
- [x] I have added screenshots for all UI updates
- [x] I process any text displayed to the user through translateText()
and I've added it to the en.json file
- [x] I have added relevant tests to the test directory
- [x] I confirm I have thoroughly tested these changes and take full
responsibility for any bugs introduced
## Please put your Discord username so you can be contacted if a bug or
regression is found:
tryout33
---------
Co-authored-by: Copilot <copilot@github.com>
152 lines
3.8 KiB
Markdown
152 lines
3.8 KiB
Markdown
# Contributing to OpenFront.io
|
|
|
|
First off, thank you for considering contributing to OpenFront.io! It's people like you that make OpenFront such a great game.
|
|
|
|
We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct and treat all community members with respect.
|
|
|
|
## Quick Links
|
|
|
|
- **Game**: [https://openfront.io/](https://openfront.io/)
|
|
- **Discord**: [Join the Development Discord](https://discord.gg/K9zernJB5z)
|
|
- **Translations**: [Crowdin Project](https://crowdin.com/project/openfront-mls)
|
|
- **Issues**: [GitHub Issues](https://github.com/openfrontio/OpenFrontIO/issues)
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- **Node.js**: Ensure you have a recent version installed.
|
|
- **npm**: Version 10.9.2 or higher.
|
|
- **Git**: For version control.
|
|
|
|
### Installation
|
|
|
|
1. **Fork the repository** on GitHub.
|
|
2. **Clone your fork** locally:
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/OpenFrontIO.git
|
|
cd OpenFrontIO
|
|
```
|
|
3. **Install dependencies**:
|
|
> **Important**: Use `npm run inst` instead of `npm install`. This runs `npm ci --ignore-scripts` to ensure a consistent and secure environment.
|
|
```bash
|
|
npm run inst
|
|
```
|
|
|
|
### Running the Game
|
|
|
|
- **Full Development Mode** (Client + Server):
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
This starts the webpack dev server and the game server, and opens your browser.
|
|
|
|
- **Client Only**:
|
|
|
|
```bash
|
|
npm run start:client
|
|
```
|
|
|
|
- **Server Only**:
|
|
```bash
|
|
npm run start:server-dev
|
|
```
|
|
|
|
## Development Workflow
|
|
|
|
### Branching
|
|
|
|
Create a new branch for each feature or bug fix:
|
|
|
|
```bash
|
|
git checkout -b feature/your-feature-name
|
|
# or
|
|
git checkout -b fix/issue-number-bug-name
|
|
```
|
|
|
|
### Coding Standards
|
|
|
|
We enforce code quality using ESLint and Prettier.
|
|
|
|
- **Format Code**:
|
|
```bash
|
|
npm run format
|
|
```
|
|
- **Lint Code**:
|
|
```bash
|
|
npm run lint
|
|
```
|
|
- **Lint & Fix**:
|
|
```bash
|
|
npm run lint:fix
|
|
```
|
|
|
|
### Testing
|
|
|
|
All new features and bug fixes should include relevant tests. We use **Vitest**.
|
|
|
|
- **Run Tests**:
|
|
```bash
|
|
npm test
|
|
```
|
|
- **Run Coverage**:
|
|
```bash
|
|
npm run test:coverage
|
|
```
|
|
|
|
**Note**: All code changes in `src/core` **MUST** be tested to ensure game logic stability.
|
|
|
|
## Submitting a Pull Request
|
|
|
|
1. **Commit your changes**:
|
|
- Write clear, concise commit messages.
|
|
- Use the present tense ("Add feature" not "Added feature").
|
|
|
|
```bash
|
|
git commit -m "Add new map rendering logic"
|
|
```
|
|
|
|
2. **Push to your fork**:
|
|
|
|
```bash
|
|
git push origin feature/your-feature-name
|
|
```
|
|
|
|
3. **Open a Pull Request (PR)**:
|
|
- Go to the original repository and click "New Pull Request".
|
|
- Select your branch.
|
|
- Fill out the **PR Template** completely.
|
|
|
|
### PR Checklist
|
|
|
|
Before submitting, ensure you have:
|
|
|
|
- [ ] Linked the relevant issue (e.g., `Resolves #123`).
|
|
- [ ] Added screenshots for any UI changes.
|
|
- [ ] Processed text through `translateText()` and added strings to `en.json`.
|
|
- [ ] Added/Updated tests in the `tests/` directory.
|
|
- [ ] Verified that `npm test` passes.
|
|
- [ ] Provided your Discord username in the PR description for communication.
|
|
|
|
## Translations
|
|
|
|
We use Crowdin for translations. If you want to help translate OpenFront.io:
|
|
|
|
1. Join the [Translation Discord](https://discord.gg/3zZzacjWFr).
|
|
2. Visit our [Crowdin Project](https://crowdin.com/project/openfront-mls).
|
|
3. Select your language or request a new one.
|
|
|
|
## Project Structure
|
|
|
|
- `src/client`: Frontend game client (rendering, input, UI).
|
|
- `src/server`: Backend game server (networking, game state).
|
|
- `src/core`: Shared game logic used by both client and server.
|
|
- `resources`: Static assets (images, sounds, maps).
|
|
- `tests`: Unit and integration tests.
|
|
|
|
## License
|
|
|
|
By contributing, you agree that your contributions will be licensed under the [GNU Affero General Public License v3.0 (AGPL v3.0)](LICENSE).
|