thayol/unalike
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Thayol
2021-06-11 14:41:45 +02:00
parent dd443a563d
commit a1982ba633
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -20,7 +20,7 @@ By the way, I'm [Thayol][thayol-osu-url], feel free to ask me any questions anyw
- Create osu! lobbies using a custom web interface.
- Send invites to users using the web interface.
- Synchronize the mapset across the lobbies.
- (Optinally) Write ".desync" in #multiplayer to turn off syncing temporarily.
- (Optinally) Write `.desync` in `#multiplayer` to turn off syncing temporarily.
- Display the results based on accuracy. (So that everyone has equal chance of winning.)
- Supports all game modes, and the score calculation is fully\* independent of the lobby settings.
@@ -36,10 +36,10 @@ By the way, I'm [Thayol][thayol-osu-url], feel free to ask me any questions anyw
## Setup
1. Clone the source code to a subfolder of your web server.
2. Copy the files from "setup_help/" to the root of Unalike. Guide [here][setup-help-guide].
2. Copy the files from `setup_help/` to the root of Unalike. Guide [here][setup-help-guide].
3. Fill in the missing keys in the newly copied files.
4. (Optional) Check the configuration section of unalike.py
5. Set up a URL rewrite rule that makes "path/to/unalike/api/USERNAME/KEY/VALUE" point to "path/to/unalike/API/?username=USERNAME&KEY=VALUE" (You can just rewrite these calls manually if you want to, but using API parameters like this is very user friendly.)
5. Set up a URL rewrite rule that makes `path/to/unalike/api/USERNAME/KEY/VALUE` point to `path/to/unalike/API/?username=USERNAME&KEY=VALUE` (You can just rewrite these calls manually if you want to, but using API parameters like this is very user friendly.)
## Start
setup_help/README.md
+5 -5
View File
@@ -6,8 +6,8 @@ For the sake of readability, I'll list the basic steps here.
## IRC Authentication
- Copy "/setup_help/account.php" to "/account.php" OR create a new file and write "<?php" to its first line.
- Get your IRC details from the [Bancho IRC Setup][osu-irc-url] page and copy the contents from the slightly darker box to the file. Make sure to keep the first line as "<?php" only.
- Copy `/setup_help/account.php` to `/account.php` OR create a new file and write `<?php` to its first line.
- Get your IRC details from the [Bancho IRC Setup][osu-irc-url] page and copy the contents from the slightly darker box to the file. Make sure to keep the first line as `<?php` only.
![irc-details](img/irc_details.png)
@@ -15,14 +15,14 @@ For the sake of readability, I'll list the basic steps here.
## osu! API Authentication
- Copy "/setup_help/api_key.php" to "/api_key.php"
- Change the $api_key variable's contents to your "API Key" from the [API Registration][osu-api-v1-url] page.
- Copy `/setup_help/api_key.php` to `/api_key.php`
- Change the $api_key variable's contents to your `API Key` from the [API Registration][osu-api-v1-url] page.
- Register a new OAuth application in your [profile settings][osu-api-v2-url].
- Change the $client_id, $client_secret, and $callback_uri to their given values respectively.
## Unalike Shared Local Secret For Anti-abuse
- Copy "/setup_help/local_secret.php" to "/local_secret.php"
- Copy `/setup_help/local_secret.php` to `/local_secret.php`
- Change the $local_secret variable's contents to a secure and preferably long string of numbers and letters.
*(Using symbols and special characters in the local secret is possible but discouraged.)*