Talon/chat_grid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Polish top-level README

Browse Source
This commit is contained in:
Jage9
2026-03-09 00:26:45 -04:00
parent d10f45d4e2
commit 1eb582f730
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,5 +1,5 @@
#Chat Grid # Chat Grid
##A Mostly Vibed, Audio-first Interactive Playground ## A Mostly Vibed, Audio-first Interactive Playground
Chat Grid is one of those projects that started with a random idea, and then grew to be many things, but most with spacial audio as its core. Briefly put, Chat Grid allows users to move around a grid and interact with each other, or with items placed on the grid. Your voice, as well as items are shared as positional audio. Item types currently range from dice and a wheel to a fully-playable toy piano and media players with directional audio. New item types can be added as plugins. Chat Grid is one of those projects that started with a random idea, and then grew to be many things, but most with spacial audio as its core. Briefly put, Chat Grid allows users to move around a grid and interact with each other, or with items placed on the grid. Your voice, as well as items are shared as positional audio. Item types currently range from dice and a wheel to a fully-playable toy piano and media players with directional audio. New item types can be added as plugins.
@@ -30,7 +30,6 @@ Notes:
- Server bind/port defaults are `127.0.0.1:8765` unless changed in config or CLI flags. - Server bind/port defaults are `127.0.0.1:8765` unless changed in config or CLI flags.
- Client dev defaults to Vite local host/port (`localhost:5173`) unless flags override. - Client dev defaults to Vite local host/port (`localhost:5173`) unless flags override.
- Server runtime env lives in `server/.env`; `server/.env.sample` shows the required variables. - Server runtime env lives in `server/.env`; `server/.env.sample` shows the required variables.
- `deploy/scripts/install_server.sh` creates `server/.env` with `CHGRID_AUTH_SECRET` automatically if missing.
Common server overrides: Common server overrides:
- `uv run python main.py --config /path/to/config.toml` - `uv run python main.py --config /path/to/config.toml`
@@ -39,15 +38,15 @@ Common server overrides:
- `uv run python main.py --ssl-cert /path/fullchain.pem --ssl-key /path/privkey.pem` - `uv run python main.py --ssl-cert /path/fullchain.pem --ssl-key /path/privkey.pem`
- `uv run python main.py --bootstrap-admin` (one-time admin creation) - `uv run python main.py --bootstrap-admin` (one-time admin creation)
## Production Deploy (quick path) ## Production Deploy
Use `deploy/README.md`. Use `deploy/README.md` for the full deployment guide.
Summary: Summary:
1. Copy repo to your server. 1. Copy repo to your server.
2. Build client and publish `client/dist/` to your web root/subdirectory. 2. Run `./deploy/scripts/install_server.sh`.
3. Configure server `config.toml` and run it via `systemd`. 3. Publish the client with `./deploy/scripts/up.sh`.
4. Add base-path-scoped websocket/auth proxy routes from `deploy/apache/chgrid-vhost-snippet.conf`. 4. Add websocket/auth proxy routes using `deploy/apache/chgrid-vhost-snippet.conf`.
## Key Paths ## Key Paths
@@ -66,10 +65,10 @@ Summary:
- Item schema reference: `docs/item-schema.md` - Item schema reference: `docs/item-schema.md`
- Local dev commands: `docs/local.md` - Local dev commands: `docs/local.md`
##Contributing ## Contributing
Contributions and ideas are welcome. The grid is already home to several rather absurd ideas, and yours may fit right in. Please look over the docs and other files for guidance, or ask for help. Contributions and ideas are welcome. The grid is already home to several rather absurd ideas, and yours may fit right in. Please look over the docs and other files for guidance, or ask for help.
##Notes on AI Coding ## Notes on AI Coding
This project has been largely coded using AI tools, with a lot of human prompting and hand-holding to enforce best practices. All ideas for improving the project or its design are welcome. This project has been largely coded using AI tools, with a lot of human prompting and hand-holding to enforce best practices. All ideas for improving the project or its design are welcome.
## License ## License