Skip to content

Commit

Permalink
update: improve freeleech readme instructions and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Roardom committed May 28, 2024
1 parent b60c672 commit 30b9efb
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,28 +109,29 @@ To gracefully exit the tracker:
sudo supervisorctl stop unit3d-announce:unit3d-announce_00
```

### Global Freeleech or Double Upload Events
> When using the Rust based UNIT3D Announce tracker, the global freeleech and double upload events are handled by the external tracker itself. This means you must activate the events in the `config/other.php` file within UNIT3D as normal for timer and then also within the `.env` file of the UNIT3D Announce tracker.
## Global Freeleech or Double Upload Events

To enable\disable global freeleech or double upload events, you need to adjust the following environment variables in the `.env` file and then restart the tracker using the supervisorctl command above.:
> [!IMPORTANT]
> When using the Rust-based UNIT3D-Announce tracker, the global freeleech and double upload events are handled by the external tracker itself. This means you must activate the events in the `config/other.php` file within UNIT3D as normal to show the timer and then also within the `.env` file of the UNIT3D-Announce tracker to update user stats correctly.
To enable/disable global freeleech or double upload events, you need to adjust the following environment variables in the `.env` file and then [restart the tracker](#startingrestarting-unit3d-announce).

```sh
# The upload_factor is multiplied by 0.01 before being multiplied with
# the announced uploaded parameter and saved in the "credited" upload
# column. An upload_factor of 200 means global double upload.
#
# Default: 100
UPLOAD_FACTOR=100
UPLOAD_FACTOR=200

# The download factor is multiplied by 0.01 before being multiplied
# with the announced downloaded parameter and saved in the "credited"
# download column. A download_factor of 0 means global freeleech.
#
# Default: 100
DOWNLOAD_FACTOR=100
DOWNLOAD_FACTOR=0
```


## Performance

UNIT3D's PHP announce can handle ~250 HTTP requests per second per core on modern hardware.
Expand Down

0 comments on commit 30b9efb

Please sign in to comment.