Skip to content

RebelliumGames/OpenTG

Repository files navigation

OpenTG

OpenTG is the open-source continuation of a previously developed video game project that is no longer under active development.
This repository makes the game’s core systems, tools, and assets publicly available for learning, modification, and community-driven experimentation.

⚠️ Note: While OpenTG is open source, the original game’s brand name, title, and logos remain protected.
Any derivative projects must not use the original game’s name or branding.

🧩 About the Project

OpenTG is built with SvelteKit for the web front-end and Tauri for the Windows desktop version.

🧰 Prerequisites

Before setting up OpenTG, install the following tools:

1. Code Editor

2. Bun

OpenTG uses Bun as its runtime and package manager.

3. Cargo (for Tauri)

The desktop version is built with Tauri, which requires Rust and Cargo.

📦 Installation

Clone the repository and install dependencies with Bun:

bun install

This installs all required packages for both the web and desktop builds.

🚀 Running the Project

Start the Web Version Run the local development server:

bun run dev:web

This starts the SvelteKit app locally, typically at http://localhost:5173

🗂️ Project Structure

project-root/
├── src/ # SvelteKit project source
│ ├── lib/ # Reusable modules, assets, and logic
│ │ ├── assets/ # Images, sounds, and other static game assets
│ │ ├── components/ # Svelte components used across the app
│ │ └── ts/ # TypeScript files for game logic and systems
│ │
│ ├── routes/ # UI routes and game interface (Svelte pages)
│ │ ├── +layout.svelte # Root layout component
│ │ ├── (game)/ # Game route and UI
│ │ └── (mainmenu)/ # MainMenu route and UI
│ │
│ └── app.html # HTML template for SvelteKit
│
├── src-tauri/ # Tauri source code for desktop build
│ ├── src/ # Rust backend
│ ├── icons/ # App icons for desktop packaging
│ └── tauri.conf.json # Tauri configuration file
│
├── static/ # Static files (favicon, desktop icons)
│ ├── desktop-icon.png
│ └── favicon.svg
│
├── .dist/ # Bundled builds for distribution (e.g., Itch.io)
│ └── web/
│   └── OpenTG-web-v0.2.1
│
├── package.json # Project dependencies and scripts
├── svelte.config.js # SvelteKit configuration
└── tsconfig.json # TypeScript configuration

Building the Project

Web Build

bun run build:web

Then bundle the game into a zip file to easily upload it on itchio by running the command

bun run bundle:web

Windows Build

To build an exe installer for windows run the command

bun run tauri build

🖼️ Generating Desktop Icons

To generate platform-specific icons for the Tauri desktop version, follow these steps:

  1. Place your base icon image and rename it to desktop-icon.png inside the /static directory.
    This image will serve as the source for all generated icons.

  2. Run the following command in your terminal:

     bun run tauri:generate:icon

    This will output generated icons into:

    src-tauri/icons

    These icons will automatically be used in the Tauri desktop build.

⚖️ Usage Policy

OpenTG is released as an open-source rewrite of the original game. You are free to:

  • Fork, modify, and distribute the project.
  • Create your own games or tools based on this codebase.
  • Monetize derivative works if desired.

However, you may not:

  • Use the original game’s name, brand, or logos in your projects.
  • Present derivative works as official or endorsed by the original development team.

You can reference the project as being “based on OpenTG” — but not under the original game’s title.

🧑‍💻 Developer Note

This repository is provided to keep the spirit of the original game alive through community-driven creativity.
While active development has stopped for now, the project may resume in the future, so please respect the brand guidelines and keep your forks clearly distinct.

📜 License

All code and assets in this project are released under the MIT License (see the LICENSE file for details). You are free to use, modify, and distribute the project, provided you comply with the license terms and respect the brand usage policy above.

About

OpenTG is the open-source continuation of a previously developed video game project that is no longer under active development.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors