mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-21 11:50:42 +00:00
VariableVince
51eccf512b
## Description: Update rest of Jest to v30. Fixes #1205 and complements #1206. Remove some more unused dependencies, complements #1207: - @types/uuid (since uuid is updated to v11, see below) - @types/raphael - node-addon-api - node-gyp - priority-queue-typescript (@datastructures-js/priority-queue stays) - rate-limiter-flexible - wheelnav - raphael Update some others too: - ~~@types/node: ^24.0.1 (guess it would go along with dockerfile node:24-slim)~~ - copy-webpack-plugin: ^13.0.0 (not affected by the breaking change: only affects use of globOptions, while we only use options in webpack.config.js) - lint-staged: ^16.1.2 (not affected by the major changes in v16 it seems https://github.com/lint-staged/lint-staged/releases) - node-gyp: ^11.2.0 (breaking change v11 was drop of node v16, not affected) - sharp: ^0.34.2 (0.34 contains braking changes. https://sharp.pixelplumbing.com/changelog/#v0340---4th-april-2025. However, we don't use the touched functions so no braking changes for us (array of images to one image or to gif, ensureAlpha or removeAlpha, animated:true which was fixed in 0.34.2 already, info.size, background metadata). - sinon: ^21.0.0 (Not sure if this is used and stil needed? Two breaking changes since our v18, one method that was never used apparently, and two others that we probably also not use as i couldn't find anything on it) - uuid: ^11.1.0 (https://github.com/uuidjs/uuid#readme . We're not affected by the breaking changes. We don't use parse(), stringify(), or pass an option#buf argument in UsernameInput.ts where we use uuidv4. Supports Typescript from v11 and advises to remove @types/uuid from dependencies because of that) - webpack-cli: ^6.0.1 (v6 had breaking changes but none of those are applicable to us. We don't use the commands or option in the webpack scripts in package.json. And our node, webpack and webpack-dev-server versions are newer). ## 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 - [x] I understand that submitting code with bugs that could have been caught through manual testing blocks releases and new features for all contributors ## Please put your Discord username so you can be contacted if a bug or regression is found: tryout33
OpenFrontIO
OpenFront is an online real-time strategy game focused on territorial control and alliance building. Players compete to expand their territory, build structures, and form strategic alliances in various maps based on real-world geography.
This is a fork/rewrite of WarFront.io. Credit to https://github.com/WarFrontIO.
OpenFront - Licensing
This project uses a dual-licensing approach:
- Code in the
server/andcore/directory is licensed under MIT - Client code (in the
client/directory) is licensed under GPL v3
🌟 Features
- Real-time Strategy Gameplay: Expand your territory and engage in strategic battles
- Alliance System: Form alliances with other players for mutual defense
- Multiple Maps: Play across various geographical regions including Europe, Asia, Africa, and more
- Resource Management: Balance your expansion with defensive capabilities
- Cross-platform: Play in any modern web browser
📋 Prerequisites
- npm (v10.9.2 or higher)
- A modern web browser (Chrome, Firefox, Edge, etc.)
🚀 Installation
-
Clone the repository
git clone https://github.com/openfrontio/OpenFrontIO.git cd OpenFrontIO -
Install dependencies
npm i
🎮 Running the Game
Development Mode
Run both the client and server in development mode with live reloading:
npm run dev
This will:
- Start the webpack dev server for the client
- Launch the game server with development settings
- Open the game in your default browser
Client Only
To run just the client with hot reloading:
npm run start:client
Server Only
To run just the server with development settings:
npm run start:server-dev
🛠️ Development Tools
-
Format code:
npm run format -
Lint code:
npm run lint -
Lint and fix code:
npm run lint:fix -
Testing
npm test
🏗️ Project Structure
/src/client- Frontend game client/src/core- Shared game logic/src/server- Backend game server/resources- Static assets (images, maps, etc.)
📝 License
This project is licensed under the terms found in the LICENSE file.
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Request to join the development Discord.
- Fork the repository
- Create your feature branch (
git checkout -b amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin amazing-feature) - Open a Pull Request
🌐 Translation
Translators are welcome! Please feel free to help translate into your language. How to help?
- Request to join the translation Discord
- Go to the project's Crowdin translation page: https://crowdin.com/project/openfront-mls
- Login if you already have an account/ Sign up if you don't have one
- Select the language you want to translate in/ If your language isn't on the list, click the "Request New Language" button and enter the language you want added there.
- Translate the strings
Project Governance
- The project maintainer (evan) has final authority on all code changes and design decisions
- All pull requests require maintainer approval before merging
- The maintainer reserves the right to reject contributions that don't align with the project's vision or quality standards
Contribution Path for New Contributors
To ensure code quality and project stability, we use a progressive contribution system:
-
New Contributors: Limited to UI improvements and small bug fixes only
- This helps you become familiar with the codebase
- UI changes are easier to review and less likely to break core functionality
- Small, focused PRs have a higher chance of being accepted
-
Established Contributors: After several successful PRs and demonstrating understanding of the codebase, you may work on more complex features
-
Core Contributors: Only those with extensive experience with the project may modify critical game systems
How to Contribute Successfully
-
Before Starting Work:
- Open an issue describing what you want to contribute
- Wait for maintainer feedback before investing significant time
- Small improvements can proceed directly to PR stage
-
Code Quality Requirements:
- All code must be well-commented and follow existing style patterns
- New features should not break existing functionality
- Code should be thoroughly tested before submission
- All code changes in src/core MUST be tested.
-
Pull Request Process:
- Keep PRs focused on a single feature or bug fix
- Include screenshots for UI changes
- Describe what testing you've performed
- Be responsive to feedback and requested changes
-
Testing Requirements:
- Verify your changes work as expected
- Test on multiple systems/browsers if applicable
- Document your testing process in the PR
Communication
- Be respectful and constructive in all project interactions
- Questions are welcome, but please search existing issues first
- For major changes, discuss in an issue before starting work
Final Notes
Remember that maintaining this project requires significant effort. The maintainer appreciates your contributions but must prioritize long-term project health and stability. Not all contributions will be accepted, and that's okay.
Thank you for helping make OpenFront better!