BlueGit

projects-timfalken-com microchess

Files

microchess / README.md

README.md

feat: scaffold Synhex hex tactics on the Microchess lobby shell
timfa project_86226080_bot_b6e0858ac0a12dc6d49a8d25b3b0be9b · pushed by timfa · 2 months ago
24f20754 History
README.md 1.7 KiB Download Raw

Synhex

A simultaneous-turn hex tactics game (Frozen Synapse–inspired) with friends, invitation links, rematches, personal avatars and SQLite storage. Seeded from Microchess's match/lobby shell.

The complete application is in web/. Files outside that folder are for repository tooling and CI only. Start locally:

php -S 127.0.0.1:8080 -t web web/router.php

Localhost automatically uses a test account. See web/README.md for setup, OAuth (auth.timfalken.com), rules and tests.

Game balance knobs (accuracy, weapons, walk range, grid size, walls, vision) live in one file: web/lib/game-config.php. OAuth secrets stay in the generated, gitignored web/data/config.php.

This branch is the seed for a future GitLab project Timfa/synhex. Production FTP deploy is disabled until that host exists.

GitLab CI/CD

The default branch is master. .gitlab-ci.yml runs PHP/hex/API tests, JavaScript checks and a real FTP fixture test. The ftp_upload deploy job is set to when: never so pipelines never upload. Re-enable it when production exists.

Required CI variables (unused until deploy is turned back on):

VariableValue
timftphostFTP/FTPS/SFTP hostname or URL
timftpuserLogin name
timftppasswordPassword; configure as masked/protected in GitLab
projectftpExisting remote application directory, relative to the FTP login root or absolute

The mirror preserves the entire production data/ directory. Test artifacts, the development router and the application README are excluded from upload.

The deployment fixture can also run locally with Python 3, pyftpdlib and lftp:

python3 ci/test_deploy.py
Source
1# Synhex
2
3A simultaneous-turn hex tactics game (Frozen Synapse–inspired) with friends, invitation links, rematches, personal avatars and SQLite storage. Seeded from Microchess's match/lobby shell.
4
5The complete application is in [`web/`](web/). Files outside that folder are for repository tooling and CI only. Start locally:
6
7```sh
8php -S 127.0.0.1:8080 -t web web/router.php
9```
10
11Localhost automatically uses a test account. See [`web/README.md`](web/README.md) for setup, OAuth (`auth.timfalken.com`), rules and tests.
12
13Game balance knobs (accuracy, weapons, walk range, grid size, walls, vision) live in one file: [`web/lib/game-config.php`](web/lib/game-config.php). OAuth secrets stay in the generated, gitignored `web/data/config.php`.
14
15This branch is the seed for a future GitLab project `Timfa/synhex`. **Production FTP deploy is disabled** until that host exists.
16
17## GitLab CI/CD
18
19The default branch is `master`. `.gitlab-ci.yml` runs PHP/hex/API tests, JavaScript checks and a real FTP fixture test. The `ftp_upload` deploy job is set to `when: never` so pipelines never upload. Re-enable it when production exists.
20
21Required CI variables (unused until deploy is turned back on):
22
23| Variable | Value |
24| --- | --- |
25| `timftphost` | FTP/FTPS/SFTP hostname or URL |
26| `timftpuser` | Login name |
27| `timftppassword` | Password; configure as masked/protected in GitLab |
28| `projectftp` | Existing remote application directory, relative to the FTP login root or absolute |
29
30The mirror preserves the entire production `data/` directory. Test artifacts, the development router and the application README are excluded from upload.
31
32The deployment fixture can also run locally with Python 3, `pyftpdlib` and `lftp`:
33
34```sh
35python3 ci/test_deploy.py
36```