From ea79fbf95aec26bef2909aef4ce2cc55ca35a794 Mon Sep 17 00:00:00 2001 From: Andrew Niziolek Date: Mon, 30 Jun 2025 13:01:26 -0400 Subject: [PATCH 1/2] Update Readme.md Added more information, Discord links, and so on. Additional updates and review requested! --- README.md | 42 +++++++++++++++++++++++++++++------------- 1 file changed, 29 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 990eb999c..bfaf38051 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,23 @@ -# Terratomic.io +# 🌎 Terratomic.io + +[![Join Discord](https://img.shields.io/discord/1380341945603330148?label=Join%20Us%20on%20Discord&logo=discord&style=for-the-badge)](https://discord.gg/JNZbp4pg5y) + + +**Terratomic.io** is a fast-paced real-time strategy game focused on **territorial conquest**, **alliance-building**, and **resource management**. -**Terratomic.io** is a real-time strategy game focused on territorial conquest, alliance-building, and resource management. It is a fork of [OpenFront.io](https://github.com/openfrontio/OpenFrontIO), which itself is based on [WarFront.io](https://github.com/WarFrontIO). -## 🚀 Getting Started +## 💬 Why This Fork + +While OpenFront laid a strong foundation, Terratomic takes a different approach — placing community feedback and collaborative development at the core of its roadmap. + +This project aims to evolve based on what players actually want, with transparent priorities and active community input shaping the game's future. + +This is a game built *with* its players, not just *for* them. + +## 🤝 Contributing + +Whether you're here to squash bugs, prototype new mechanics, or improve the UI, here's how to get started: ```bash git clone https://github.com/1brucben/Terratomic.git @@ -12,20 +26,22 @@ npm install npm run dev ``` +You're now ready to start developing locally. A formal contribution guide will be published soon. + +Until then, open issues, submit pull requests or join the discussion [on Discord](https://discord.gg/JNZbp4pg5y) — we're listening. + ## 🗂️ Project Structure -- `src/client` – Game frontend -- `src/core` – Shared logic -- `src/server` – Game backend +- `src/client` – Game frontend (components, graphics, styles, utilities) +- `src/core` – Shared game logic (execution, game state, pathfinding, validations) +- `src/server` – Backend services (session control, matchmaking, gatekeeping) +- `src/scripts` – Dev or build-time scripts +- `resources/` – Static assets (flags, fonts, icons, maps, sprites, images) +- `tests/` – Unit and integration tests for client, core logic, and utilities -## 🛠 License +## 🛠 Licensing - `src/client`: GPLv3 - `src/core` and `src/server`: MIT -## 📣 Contributing - -Development is ongoing. -Public contribution guidelines will be published soon. - -© 2025 Terratomic Team +© 2025 Terratomic Team \ No newline at end of file From be16f87410509c1cf442d654f8aa324914692a55 Mon Sep 17 00:00:00 2001 From: Andrew Niziolek Date: Tue, 1 Jul 2025 10:29:45 -0400 Subject: [PATCH 2/2] Update licensing section in README Added 1brucben's updated licensing notes. --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bfaf38051..d64257265 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,16 @@ Until then, open issues, submit pull requests or join the discussion [on Discord ## 🛠 Licensing -- `src/client`: GPLv3 -- `src/core` and `src/server`: MIT +Terratomic is a fork of [OpenFront.io](https://github.com/openfrontio/OpenFrontIO), which was originally licensed under a combination of GPLv3 (for `src/client`) and MIT (for the rest of the code). That project did not include license headers in individual files. + +As part of this fork, we have **unified the license under GPLv3** for all parts of the project, **except** the `proprietary/` folder, which is governed by a separate proprietary license and a Contributor License Agreement (CLA). + +### 📂 Folder Licensing Summary + +- `src/client`, `src/core`, `src/server`, `src/scripts`, `tests/`: **GPLv3** +- `resources/`: **GPLv3** +- `proprietary/`: **Proprietary** – See [CLA.md](./CLA.md) for contributor terms + +Some third-party files may retain their original licenses (e.g. MIT); where applicable, these are noted in headers or accompanying files. © 2025 Terratomic Team \ No newline at end of file