BlueGit

blue-star tribegen

Files

tribegen / web / docs / QUICKSTART.md

QUICKSTART.md

various fixes
timfa Tim · pushed by timfa · 9 months ago
49730f61 History
QUICKSTART.md 2.6 KiB Download Raw

Quick Start Guide

Prerequisites

  • PHP 7.4 or higher
  • A web server (Apache, Nginx, or PHP built-in server)
  • SQLite3 support in PHP

Setup

Option 1: Using PHP Built-in Server (Development)

cd tribegen
php -S localhost:8000 -t public/

Then navigate to http://localhost:8000 in your browser.

Option 2: Apache/Nginx

Configure your web server to serve the public/ directory as the document root.

First Run

1. The database will be automatically created on first access 2. Register a new account with your email 3. Create a new tribe 4. Begin playing!

Game Mechanics Quick Reference

Kobold Stats

  • Vitality: Health and resistance to injury/disease
  • Intelligence: Problem-solving and learning
  • Tinkering: Crafting and repair ability
  • Medicine: Healing and medical knowledge
  • Crafting: Creation of items and goods
  • Personality: Social interactions and morale
  • Will: Mental fortitude and determination

All stats range from 0-100 and are displayed as text descriptions rather than numbers.

Age Tiers

  • Egg (age < 0): Surprise births
  • Baby (age 0-3): Reduced stats
  • Adult (age 4-34): Full potential
  • Old (age 35-59): Reduced stats, potential old-age injuries
  • Very Old (age 60+): Limited capability

Injuries

  • Each injury has a severity (1-10)
  • Total injury severity ≥ Kobold's vitality = Death
  • Injuries can be treated with medicine
  • Old-age injuries cannot be cured

Items

  • Items can modify stats (+1, -1, etc., never multipliers)
  • Items are stored in tribe storage
  • Kobolds can equip items for stat bonuses
  • Items don't disappear when Kobold dies

Events

  • Player-initiated events (hunting, exploration, farming)
  • Automatic month-progression events
  • Events can kill, injure, or add Kobolds
  • Events can find or create items

Expandable Systems

Adding Events

Events are easily expandable. Create a new file in src/Events/ extending the Event class and register it in EventManager.

Adding Injuries

Add new injury types by creating them in events. Each injury has a category and severity.

Adding Items

Items can have any combination of stat modifications and are created through events or game setup.

Troubleshooting

"Database is locked"

  • Ensure the data/ directory exists and is writable
  • Close any other instances of the game accessing the same save

PHP errors

  • Verify PHP 7.4+ is installed: php -v
  • Ensure SQLite3 extension is enabled
  • Check web server error logs

Game not loading

  • Clear browser cache
  • Check JavaScript console for errors (F12)
  • Verify all files are in the correct directories
Source
1# Quick Start Guide
2
3## Prerequisites
4- PHP 7.4 or higher
5- A web server (Apache, Nginx, or PHP built-in server)
6- SQLite3 support in PHP
7
8## Setup
9
10### Option 1: Using PHP Built-in Server (Development)
11```bash
12cd tribegen
13php -S localhost:8000 -t public/
14```
15Then navigate to `http://localhost:8000` in your browser.
16
17### Option 2: Apache/Nginx
18Configure your web server to serve the `public/` directory as the document root.
19
20## First Run
21
221. The database will be automatically created on first access
232. Register a new account with your email
243. Create a new tribe
254. Begin playing!
26
27## Game Mechanics Quick Reference
28
29### Kobold Stats
30- **Vitality**: Health and resistance to injury/disease
31- **Intelligence**: Problem-solving and learning
32- **Tinkering**: Crafting and repair ability
33- **Medicine**: Healing and medical knowledge
34- **Crafting**: Creation of items and goods
35- **Personality**: Social interactions and morale
36- **Will**: Mental fortitude and determination
37
38All stats range from 0-100 and are displayed as text descriptions rather than numbers.
39
40### Age Tiers
41- **Egg** (age < 0): Surprise births
42- **Baby** (age 0-3): Reduced stats
43- **Adult** (age 4-34): Full potential
44- **Old** (age 35-59): Reduced stats, potential old-age injuries
45- **Very Old** (age 60+): Limited capability
46
47### Injuries
48- Each injury has a severity (1-10)
49- Total injury severity ≥ Kobold's vitality = Death
50- Injuries can be treated with medicine
51- Old-age injuries cannot be cured
52
53### Items
54- Items can modify stats (+1, -1, etc., never multipliers)
55- Items are stored in tribe storage
56- Kobolds can equip items for stat bonuses
57- Items don't disappear when Kobold dies
58
59### Events
60- Player-initiated events (hunting, exploration, farming)
61- Automatic month-progression events
62- Events can kill, injure, or add Kobolds
63- Events can find or create items
64
65## Expandable Systems
66
67### Adding Events
68Events are easily expandable. Create a new file in `src/Events/` extending the `Event` class and register it in `EventManager`.
69
70### Adding Injuries
71Add new injury types by creating them in events. Each injury has a category and severity.
72
73### Adding Items
74Items can have any combination of stat modifications and are created through events or game setup.
75
76## Troubleshooting
77
78### "Database is locked"
79- Ensure the `data/` directory exists and is writable
80- Close any other instances of the game accessing the same save
81
82### PHP errors
83- Verify PHP 7.4+ is installed: `php -v`
84- Ensure SQLite3 extension is enabled
85- Check web server error logs
86
87### Game not loading
88- Clear browser cache
89- Check JavaScript console for errors (F12)
90- Verify all files are in the correct directories