mirror of
https://github.com/YGGverse/HLState.git
synced 2026-03-31 17:15:39 +00:00
120 lines
3.3 KiB
Markdown
120 lines
3.3 KiB
Markdown
# HLState
|
|
|
|
Web monitor for Half-Life game servers based on [Xash3D FWGS](https://github.com/FWGS/xash3d-fwgs) masters crawler.
|
|
|
|
Project initially written to explore [Yggdrasil](https://github.com/yggdrasil-network) servers, but compatible with any other network
|
|
|
|
## Features
|
|
|
|
* Live scrape of each server for online status, active map, players total
|
|
* Game session info: names, frags, time in game, etc
|
|
* Subscription for online updates and players join to server with RSS
|
|
* History keeping in SQLite DB for any charts building
|
|
* New instances crawler based on multiple master nodes
|
|
* Flexible environment settings
|
|
|
|
## Examples
|
|
|
|
* `http://94.140.114.89/hl/` - Clearnet
|
|
* `http://[201:5eb5:f061:678e:7565:6338:c02c:5251]/hl/` - Yggdrasil
|
|
* `http://hl.ygg` - Alfis DNS
|
|
|
|
## Install
|
|
|
|
* `apt install git composer curl memcached php php-xml php-intl php-mbstring php-curl php-sqlite3 php-memcached`
|
|
* `git clone https://github.com/YGGverse/HLState.git`
|
|
* `cd HLState`
|
|
* `composer install`
|
|
* `php bin/console doctrine:migrations:migrate`
|
|
|
|
### Setup
|
|
|
|
* `chown -R www-data:www-data var`
|
|
* `cp .env .env.local`
|
|
* `crontab -e` > `* * * * * /usr/bin/curl --silent http://localhost/crontab/index &> /dev/null`
|
|
|
|
#### Nginx
|
|
|
|
```
|
|
map $request_uri $loggable {
|
|
~^/crontab/index 0;
|
|
default 1;
|
|
}
|
|
|
|
server {
|
|
listen [::]:27080;
|
|
|
|
server_name hl.ygg ygg.hl.srv;
|
|
|
|
access_log /var/log/nginx/hl.access.log combined if=$loggable;
|
|
error_log /var/log/nginx/hl.error.log warn;
|
|
|
|
root /var/www/hlstate/HLState/public;
|
|
|
|
index index.php index.html;
|
|
|
|
location / {
|
|
try_files $uri /index.php$is_args$args;
|
|
}
|
|
location ~ ^/index\.php(/|$) {
|
|
fastcgi_pass unix:/run/php/php8.4-fpm.sock;
|
|
fastcgi_split_path_info ^(.+\.php)(/.*)$;
|
|
include fastcgi_params;
|
|
|
|
fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
|
|
fastcgi_param DOCUMENT_ROOT $realpath_root;
|
|
|
|
internal;
|
|
}
|
|
location ~ \.php$ {
|
|
return 404;
|
|
}
|
|
}
|
|
```
|
|
|
|
### Update
|
|
|
|
* `git pull`
|
|
* `git merge`
|
|
* `composer update`
|
|
* `php bin/console doctrine:migrations:migrate`
|
|
* `APP_ENV=prod APP_DEBUG=0 php bin/console cache:clear`
|
|
|
|
## Contribution
|
|
|
|
Please create new branch from main before make PR
|
|
|
|
* `git checkout main`
|
|
* `git checkout -b 'new-commit-branch'`
|
|
|
|
## License
|
|
|
|
* Engine sources [MIT License](https://github.com/YGGverse/HLState/blob/main/LICENSE)
|
|
|
|
## Versioning
|
|
|
|
[Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
|
|
|
|
## Components
|
|
|
|
* [Symfony Framework](https://symfony.com)
|
|
* [SVG icons](https://icons.getbootstrap.com)
|
|
* [PHP Source Query](https://github.com/xPaw/PHP-Source-Query)
|
|
* [HL-PHP](https://github.com/YGGverse/hl-php)
|
|
* [JS-less Graphs PHP](https://github.com/YGGverse/graph-php)
|
|
* [Memcached API for PHP](https://github.com/YGGverse/cache-php)
|
|
|
|
## Support
|
|
|
|
* [Issues](https://github.com/YGGverse/HLState/issues)
|
|
|
|
## Blog
|
|
|
|
* [Mastodon](https://mastodon.social/@YGGverse)
|
|
|
|
## See also
|
|
|
|
* [Xash3D FWGS builds for Yggdrasil](https://github.com/YGGverse/xash3d-fwgs/releases)
|
|
* [hl-customs](https://github.com/YGGverse/hl-customs) - Media resources for Half-Life customization
|
|
* [hl-server](https://github.com/YGGverse/hl-server) - Half-Life server edition by YGGverse
|
|
* [pymaster](https://github.com/YGGverse/pymaster) - Refactored master server written in Python
|