add SREBOT, SHARED, TSSBOT contents (fixup for #1223)
PR #1223 only staged the deletions of the old paths because the new top-level directories were still untracked when the commit was authored. This commit adds the actual restructured tree: SREBOT/ (existing bot), SHARED/ (vromfs, data_parser, ICONS/MAPS/FONTS, DAGOR_FILES, update_game_files), and TSSBOT/ (skeleton). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,70 @@
|
||||
|
||||
### Installation
|
||||
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
git clone https://github.com/Sop-rs/SREBOT_MEOW.git
|
||||
cd SREBOT_MEOW
|
||||
```
|
||||
|
||||
2. **Set up Python virtual environment**
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||||
```
|
||||
|
||||
3. **Install dependencies**
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
4. **Configure environment variables**
|
||||
```bash
|
||||
nano .env
|
||||
```
|
||||
|
||||
Edit the existing `.env` in the repo root and keep the storage path there:
|
||||
```env
|
||||
SREBOT_DEPLOY_PATH=/absolute/path/to/SREBOT_MEOW
|
||||
DISCORD_KEY=your_discord_bot_token_here
|
||||
DEEPL_KEY=your_deepl_api_key_here # Optional
|
||||
GITHUB_WEBHOOK_SECRET=your_webhook_secret # For auto-deployment
|
||||
SREBOT_STORAGE_VOL_PATH=/absolute/path/to/storage
|
||||
SREBOT_API_BEARER_TOKEN=your_internal_api_token # Optional, protects /api/*
|
||||
SREBOT_EXTERNAL_PORT=18081 # External bridge port
|
||||
SREBOT_EXTERNAL_BEARER_TOKEN=your_external_bridge_token # Optional, protects the bridge API and websocket
|
||||
SREBOT_EXTERNAL_UPSTREAM_URL=http://127.0.0.1:6000 # Internal SREBOT API to proxy
|
||||
```
|
||||
|
||||
5. **Run the bot**
|
||||
```bash
|
||||
python BotScript.py
|
||||
```
|
||||
|
||||
### AXBot bridge process
|
||||
|
||||
`ecosystem.config.js` now includes a dedicated PM2 app named `srebot-axbot`.
|
||||
It proxies read-only SREBOT queries and broadcasts replay/GOB envelopes over
|
||||
websocket on the same external port.
|
||||
Its outbox/state files live under the shared storage volume configured in
|
||||
`.env` via `SREBOT_STORAGE_VOL_PATH`.
|
||||
|
||||
Useful commands:
|
||||
|
||||
```bash
|
||||
pm2 start ecosystem.config.js --only srebot-api
|
||||
pm2 start ecosystem.config.js --only srebot-axbot
|
||||
pm2 logs srebot-axbot
|
||||
```
|
||||
|
||||
Clients should point their query client at:
|
||||
|
||||
```env
|
||||
SREBOT_API_BASE_URL=http://<srebot-host>:18081
|
||||
```
|
||||
|
||||
The bridge app logs both sides of the transfer:
|
||||
- incoming client HTTP requests
|
||||
- outgoing proxy responses
|
||||
- websocket envelopes broadcast to connected clients
|
||||
# test
|
||||
Reference in New Issue
Block a user