expanded and prettified readme

2026-06-21 09:30:45 +00:00 · 2025-03-01 21:25:31 +01:00
parent 0b5d526dbe
commit ae1ca1046f
2 changed files with 101 additions and 11 deletions
@@ -1,29 +1,104 @@
-# OpenFront.io
+# OpenFrontIO
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="resources/images/OpenFrontLogoDark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="resources/images/OpenFrontLogo.svg">
+    <img src="resources/images/OpenFrontLogo.svg" alt="OpenFrontIO Logo" width="300">
+  </picture>
+</p>

 ![Prettier Check](https://github.com/openfrontio/OpenFrontIO/actions/workflows/prettier.yml/badge.svg)

-OpenFront is an online rts.
+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.

-## Building
+## 🌟 Features

-To build the project, you will need to have Node.js and npm installed.
+- **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

-Before building the project, install the dependencies:
+## 📋 Prerequisites

-```bash
-npm install
-```
+- [Node.js](https://nodejs.org/) (v16.x or higher)
+- [npm](https://www.npmjs.com/) (v8.x or higher)
+- A modern web browser (Chrome, Firefox, Edge, etc.)

-To run dev build:
+## 🚀 Installation
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/openfrontio/OpenFrontIO.git
+   cd OpenFrontIO
+   ```
+
+2. **Install dependencies**
+
+   ```bash
+   npm install
+   ```
+
+## 🎮 Running the Game
+
+### Development Mode
+
+Run both the client and server in development mode with live reloading:

 ```bash
 npm run dev
 ```

-Make sure to format code using prettier extension or by running:
+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:

 ```bash
-npm run format
+npm run start:client
 ```
+
+### Server Only
+
+To run just the server with development settings:
+
+```bash
+npm run start:server-dev
+```
+
+## 🛠️ Development Tools
+
+- **Format code**:
+  ```bash
+  npm run format
+  ```
+
+## 🏗️ 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](LICENSE) file.
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin amazing-feature`)
+5. Open a Pull Request
@@ -0,0 +1,15 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1364 259" width="100%" height="100%" fill="currentColor">
+  <g>
+      <path d="M0,174V51h15.24v-17.14h16.81v-16.98h16.96V0h1266v17.23h17.13v16.81h16.98v16.96h14.88v123h-15.13v17.08h-17.08v17.08h-16.9v17.04H324.9v16.86h-16.9v16.95h-102v-17.12h-17.07v-17.05H48.73v-17.05h-16.89v-16.89H14.94v-16.89H0ZM1297.95,17.35H65.9v16.7h-17.08v17.08h-14.5v123.08h14.85v16.9h17.08v17.08h139.9v17.08h17.08v16.36h67.9v-16.72h17.08v-17.07h989.88v-17.07h17.08v-16.9h14.44V50.8h-14.75v-17.08h-16.9v-16.37Z" fill="#ffffff"/>
+      <path d="M189.1,154.78v17.07h-16.9v16.75h-51.07v-16.42h-16.9v-17.07h-16.97v-84.88h16.63v-17.07h16.9v-16.84h51.07v16.5h17.07v17.07h16.7v84.89h-16.54ZM137.87,53.1v17.15h-16.6v84.86h16.97v16.61h16.89v-16.97h16.6v-84.86h-16.97v-16.79h-16.89Z" fill="#ffffff"/>
+      <path d="M273.91,104.06v-16.73h50.92v16.45h16.85v68.05h-16.44v17.06h-50.96v16.88h16.4v16.96h-67.28v-16.61h16.33v-101.86h-16.38v-16.98h33.4v16.63c6.12,0,11.72,0,17.31,0,0,22.56,0,45.13,0,67.75h33.59v-67.61h-33.73Z" fill="#ffffff"/>
+      <path d="M631.12,188.64v-16.36h16.53V53.2h-16.25v-16.86h118.33v33.29h-16.65v-16.36h-50.72v50.44h33.36v-16.35h16.99v50.25h-16.6v-16.33h-33.73v50.65h16.37v16.72h-67.63Z" fill="#ffffff"/>
+      <path d="M596.78,103.8v84.94h-33.54v-84.39h-34.03v84.25h-33.85v-101.29h84.5v16.49h16.93Z" fill="#ffffff"/>
+      <path d="M1107.12,188.71v-84.34h-34.03v84.37h-33.7v-101.41h84.42v16.41h16.86v84.96h-33.54Z" fill="#ffffff"/>
+      <path d="M988.1,171.78v16.87h-67.88v-16.38h-16.87v-68.06h16.38v-16.87h68.06v16.38h16.87v68.06h-16.55ZM970.78,104.35h-33.39v67.38h33.39v-67.38Z" fill="#ffffff"/>
+      <path d="M460.77,155.38v16.49h-16.58v16.83h-68.05v-16.5h-16.83v-68.05h16.49v-16.83h68.05v16.49h16.83v34.06h-67.31v33.82h33.47v-16.31h33.92ZM393.39,104.18v16.56h33.3v-16.56h-33.3Z" fill="#ffffff"/>
+      <path d="M1209.13,172h-16.9v-67.9h-16.96v-16.9h16.68v-17.08h16.9v-16.82h16.9v33.58h50.98v16.91h-50.4v67.96h16.48v-16.43h50.95v16.54h-16.55v16.76h-68.08v-16.6Z" fill="#ffffff"/>
+      <path d="M834.91,120.94v16.96h-16.65v33.88h16.41v16.96h-67.29v-16.63h16.34v-67.87h-16.4v-16.97h50.42v33.81h17.3l-.14-.14Z" fill="#ffffff"/>
+      <path d="M835.05,121.08v-33.75h33.76v16.43h16.85v33.96h-33.43v-16.79c-6.13,0-11.73,0-17.32,0,0,0,.14.14.14.14Z" fill="#ffffff"/>
+  </g>
+</svg>