Skip to content

luyiourwong/Terminara

Repository files navigation

Terminara

Ask DeepWiki Python support

A terminal-based ai simulation game.

How to use

You can download the executable application from latest release.

The full compressed file includes the executable file and the default world settings file. You can only download the executable file if you are updating the game to the latest version.

OS Version
Windows Windows 10, Windows 11
Linux (GLIBC 2.35+) Ubuntu 22.04 LTS, Ubuntu 24.04 LTS
MacOS macOS 13, macOS 14, macOS 15, macOS 26
Manual run

Installation

  1. Clone the repository:

    git clone https://github.com/luyiourwong/Terminara
    cd Terminara
  2. Create a virtual environment:

    python -m venv .venv
    source .venv/bin/activate

    On Windows, use .venv\Scripts\activate

  3. Install the dependencies:

    pip install -e .

Start Method 1: Using the installed command (Recommended)

After installation, run the game with:

terminara

Start Method 2: Direct execution

Cross-platform way

python -m terminara.main

or

python terminara/main.py

On Windows, use terminara\main.py

for more information, see Contribute & Develop Guide.

AI Setup

After starting the application, you need to configure the AI settings from the main menu.

AI Settings

You need to fill in the following fields: (OpenAI compatibility API)

  • Host: The API endpoint. Leave it empty to use the default OpenAI endpoint.
  • API Key: Your API key for the AI service.
  • Model: The model you want to use.

Click "Apply" to save the settings.

Examples

1. OpenAI (Default)

  • Host: (leave empty)
  • API Key: YOUR_OPENAI_API_KEY
  • Model: gpt-4o-mini-2024-07-18
  • Host: https://generativelanguage.googleapis.com/v1beta/openai/
  • API Key: YOUR_GEMINI_API_KEY
  • Model: gemini-2.0-flash

World Setup

Configuration Storage

World settings are stored in the terminara/data/worlds directory. (in full release)

.
|-- terminara/
|   `-- data/
|       |-- schema/           # Json schema files for world settings
|       `-- worlds/           # Directory for world setting files
`-- terminara_platform_version        # Executable file

Creating a new world

There is a example world aethelgard.json. You can follow the schema to create a new world.

Links

License

This project is licensed under the MIT License.

About

A terminal-based ai simulation game.

Resources

License

Contributing

Stars

Watchers

Forks

Contributors 5

Languages