How runvicm/runpi-rathrest works
rAthReST is a Laravel API for rAthena account and server data, with a separate React reference client. The main workflow is account registration or login, followed by authenticated account and character views; public endpoints also expose API information and server status/statistics. Laravel controllers handle requests and Eloquent models represent game data. The README documents broader ambitions, but storage and several profile/admin functions are unfinished or only represented in client navigation. Client-to-API usage is documented generally; specific client request wiring is not established by the excerpts.
Main entry points: api.php API routes · ServerStatController.php Server status and stats · Char.php Character model · Login.php Login model
Components 20
API routing
- API routes
src/rathrest/routes/api.php - API information
src/rathrest/app/Http/Controllers/IndexController.php - Base controller
src/rathrest/app/Http/Controllers/Controller.php
Identity and accounts
- Authentication
src/rathrest/app/Http/Controllers/AuthController.php - Account views
src/rathrest/app/Http/Controllers/AccountController.php - Login model
src/rathrest/app/Models/Login.php
Game data and status
- Character model
src/rathrest/app/Models/Char.php - Guild model
src/rathrest/app/Models/Guild.php - Server status and stats
src/rathrest/app/Http/Controllers/ServerStatController.php
Reference client
- Client application
src/cp/app/root.tsx - Auth state hook
src/cp/app/hooks/useAuth.ts - Login and registration
src/cp/app/routes/auth/login.tsx - Registration page
src/cp/app/routes/auth/register.tsx - Account details
src/cp/app/routes/account/view.tsx - Character list
src/cp/app/routes/account/characters.tsx - Storage page
src/cp/app/routes/account/storage.tsx - Server information
src/cp/app/routes/server-info.tsx
Other components
- Website user
- rAthena database
- rAthena services
Connections 23
- Website user → Client application: uses
- Client application → API routes: uses API
- API routes → API information: routes to
src/rathrest/routes/api.php - API routes → Authentication: routes to
src/rathrest/routes/api.php - API routes → Account views: routes to
src/rathrest/routes/api.php - API routes → Server status and stats: routes to
src/rathrest/routes/api.php - Authentication → Login model: creates and checks
src/rathrest/app/Http/Controllers/AuthController.php - Account views → Login model: reads account
src/rathrest/app/Http/Controllers/AccountController.php - Account views → Character model: reads characters
src/rathrest/app/Http/Controllers/AccountController.php - Character model → Guild model: loads guild
src/rathrest/app/Models/Char.php - Server status and stats → Login model: counts accounts
src/rathrest/app/Http/Controllers/ServerStatController.php - Server status and stats → Character model: counts characters
src/rathrest/app/Http/Controllers/ServerStatController.php - Login model → rAthena database: maps table
- Character model → rAthena database: maps table
- Guild model → rAthena database: maps table
- Server status and stats → rAthena services: probes services
src/rathrest/app/Http/Controllers/ServerStatController.php - Website user → Login and registration: signs in
- Website user → Registration page: registers
- Website user → Account details: views account
- Website user → Character list: views characters
- Website user → Storage page: views storage
- Website user → Server information: checks status
src/cp/app/routes/server-info.tsx - Auth state hook → API routes: uses API