mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-22 23:55:21 +00:00
VariableVince
01ef525e11
## Description: New images in Instructions where needed for: - event panel: wasn't mentioned yet - infopanel changed: quick chat, donate gold, stop/start trading etc - player icons: traitor, embargo, requesting alliance - radial menu: now differs between enemy/ally - leaderboard: was changed - options: time display was changed, cookie preferences button is now visible so kept that in the new image Some justifcations of part of the textual changes: - Trade: info was already behind and now updated to include changes from PR https://github.com/openfrontio/OpenFrontIO/pull/707 - Retreats: weren't yet mentioned. Added this to new info about Event panel. Including https://github.com/openfrontio/OpenFrontIO/pull/699, and not-yet-but-soon merged PR https://github.com/openfrontio/OpenFrontIO/pull/740 and https://github.com/openfrontio/OpenFrontIO/pull/705 - Radial Menu: close button has been replaced, explain that right-clicking closes it now. - Traitor: being a traitor and its consequences, like the changed defense debuff and effects on trade. - SAM: launcher hit chanches % changed. - Port: Battleships > Warships and other changes. - Warship: made more clear that only enemy trade ships/warships/boats are captured/destroyed. Made 'attack-click' more clear. - Boat: the word Boat was used, not Transport ship. While on server and in code it is called a Transport (ship) too. Tried to clear this up. Since it is now explained n Instructions, it doesn't have to be clarified per se elsewhere. Like in Build menu for Warship it says "Captures trade ships, destroys ships and boats" which can stay this way as it is now assumed knowledge that boat = transport. - More uniform capitalisation for 'Openfront' terms: capitalization was used differently across terms like Info panel and build menu, Alternate view and Alternate View. Other instances are more ambiguous like "Small explosive bomb that destroys territory, buildings, ships and boats" which i kept as is. - Embargo: the word 'embargo' was deliberately removed earlier, because it wasn't always understood by target audience (https://github.com/openfrontio/OpenFrontIO/pull/147). But some remnants were left. Using 'stop trading' in all but one spot now: it's used as one-word explanation for the Dollar stop sign player icon, just like other icons also have short 'Ally' 'Traitor' etc. So the players who do use the word embargo still have one reference left. - Build menu: left Warship description as is (see 'Boat:' above). Updated Port description from "Sends trade ships to allies to generate gold" to "Sends trade ships to generate gold". Trade is not only with allies anymore. And there's more details that are in Instructions like the effects stop/start trading, that don't have to be in the Build menu. This lessens the chances of having to change the Port description in Build menu again. - Player info: changed "Embargo against you" to "Stopped trade with you" (see 'Embargo:' above). Keys that need to be (re)translated in MLS: - NEW keys: info_chat, info_trade, ally_donate_gold, build_menu_desc, icon_embargo, icon_request, ui_playeroverlay, ui_playeroverlay_desc, ui_events, ui_events_desc, ui_events_alliance, ui_events_attack, ui_events_quickchat - UPDATED keys: info_enemy_desc, ally_betray, build_port_desc, build_warship_desc, build_sam_desc, icon_crown, icon_traitor, radial_boat, radial_build, build_menu.desc.port, embargo, option_settings, build_defense_desc, radial_desc, ui_leaderboard_desc Font looks weird in screenshots because of zoom 40% in browser to capture it all:       ## Please complete the following: - [x] I have added screenshots for all UI updates - [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 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features** - Added new UI elements and icons for alliance requests, embargo status, and gold donation in the help modal and player info panels. - Introduced detailed sections in the help modal for events, player overlays, and expanded build menu explanations. - **Improvements** - Enhanced and clarified descriptions for leaderboard, event panels, player overlays, ally betrayal, and build menu items. - Improved visual grouping, layout, and styling consistency in the help modal and across UI icons. - **Style** - Updated and unified image and icon styles for consistent appearance in the help modal. - Added new CSS classes for modal images and icons; removed fixed-size radial menu image style. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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
🏗️ 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!