BlueGit

blue-star tribegen

Files

tribegen / web / docs / START.md

START.md

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

Start the Game

Quick Start (Windows)

Option 1: Run Directly (Recommended)

cd e:\Development\Repositories\tribegen
php -S localhost:8000 -t public/

Then open your browser to: http://localhost:8000

Option 2: Using PowerShell Script

Run this command in PowerShell:

cd e:\Development\Repositories\tribegen; php -S localhost:8000 -t public/

Option 3: Using Batch File

Create a file named start.bat with:

@echo off
cd /d "%~dp0"
php -S localhost:8000 -t public/
pause

Then double-click start.bat to start.

---

Troubleshooting

PHP Not Found

Make sure PHP is installed and in your PATH:

php -v

If not installed:

  • Download from https://www.php.net/downloads
  • Add PHP folder to Windows PATH
  • Restart terminal/PowerShell

Port 8000 Already in Use

If port 8000 is busy, use a different port:

php -S localhost:8001 -t public/

Then open: http://localhost:8001

Database Error

The database is automatically created. If you get an error: 1. Ensure data/ folder exists (it should) 2. Make sure data/ is writable 3. Delete data/tribegen.db if corrupted 4. Refresh the page

Can't Connect

  • Make sure you're using http:// not https://
  • Try 127.0.0.1:8000 instead of localhost:8000
  • Check firewall isn't blocking port 8000

---

What to Do After Starting

1. Register a new account (any email/password) 2. Login with your account 3. Create New Tribe button 4. Enter tribe name and generate 5. Select leader and name them 6. Select 5 members for your tribe 7. Play the game!

---

Game Features to Try

  • Click events (hunting, exploration, farming)
  • End month to progress time
  • Watch kobolds age
  • See what happens during events

---

File Locations

  • Game files: e:\Development\Repositories\tribegen\public\
  • Database: e:\Development\Repositories\tribegen\data\tribegen.db
  • Code: e:\Development\Repositories\tribegen\src\

---

Browser Requirements

Any modern browser:

  • Chrome/Edge (recommended)
  • Firefox
  • Safari
  • Opera

---

Stop the Server

Press Ctrl+C in the PowerShell/Command Prompt window.

---

More Information

  • GETTING_STARTED.md - Full getting started guide
  • QUICKSTART.md - Gameplay guide
  • README.md - Feature list
  • ARCHITECTURE.md - Technical details

---

Common URLs

  • Game: http://localhost:8000
  • Alternative: http://127.0.0.1:8000
  • Different port: http://localhost:8001 (if 8000 busy)

---

Enjoy your Kobold tribe! 🎮

Source
1# Start the Game
2
3## Quick Start (Windows)
4
5### Option 1: Run Directly (Recommended)
6```powershell
7cd e:\Development\Repositories\tribegen
8php -S localhost:8000 -t public/
9```
10
11Then open your browser to: **http://localhost:8000**
12
13### Option 2: Using PowerShell Script
14Run this command in PowerShell:
15```powershell
16cd e:\Development\Repositories\tribegen; php -S localhost:8000 -t public/
17```
18
19### Option 3: Using Batch File
20Create a file named `start.bat` with:
21```batch
22@echo off
23cd /d "%~dp0"
24php -S localhost:8000 -t public/
25pause
26```
27
28Then double-click `start.bat` to start.
29
30---
31
32## Troubleshooting
33
34### PHP Not Found
35Make sure PHP is installed and in your PATH:
36```powershell
37php -v
38```
39
40If not installed:
41- Download from https://www.php.net/downloads
42- Add PHP folder to Windows PATH
43- Restart terminal/PowerShell
44
45### Port 8000 Already in Use
46If port 8000 is busy, use a different port:
47```powershell
48php -S localhost:8001 -t public/
49```
50
51Then open: **http://localhost:8001**
52
53### Database Error
54The database is automatically created. If you get an error:
551. Ensure `data/` folder exists (it should)
562. Make sure `data/` is writable
573. Delete `data/tribegen.db` if corrupted
584. Refresh the page
59
60### Can't Connect
61- Make sure you're using `http://` not `https://`
62- Try `127.0.0.1:8000` instead of `localhost:8000`
63- Check firewall isn't blocking port 8000
64
65---
66
67## What to Do After Starting
68
691. **Register** a new account (any email/password)
702. **Login** with your account
713. **Create New Tribe** button
724. **Enter tribe name** and generate
735. **Select leader** and name them
746. **Select 5 members** for your tribe
757. **Play the game!**
76
77---
78
79## Game Features to Try
80
81- Click events (hunting, exploration, farming)
82- End month to progress time
83- Watch kobolds age
84- See what happens during events
85
86---
87
88## File Locations
89
90- Game files: `e:\Development\Repositories\tribegen\public\`
91- Database: `e:\Development\Repositories\tribegen\data\tribegen.db`
92- Code: `e:\Development\Repositories\tribegen\src\`
93
94---
95
96## Browser Requirements
97
98Any modern browser:
99- Chrome/Edge (recommended)
100- Firefox
101- Safari
102- Opera
103
104---
105
106## Stop the Server
107
108Press `Ctrl+C` in the PowerShell/Command Prompt window.
109
110---
111
112## More Information
113
114- **GETTING_STARTED.md** - Full getting started guide
115- **QUICKSTART.md** - Gameplay guide
116- **README.md** - Feature list
117- **ARCHITECTURE.md** - Technical details
118
119---
120
121## Common URLs
122
123- Game: **http://localhost:8000**
124- Alternative: **http://127.0.0.1:8000**
125- Different port: **http://localhost:8001** (if 8000 busy)
126
127---
128
129Enjoy your Kobold tribe! 🎮