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:51:00 +02:00
parent a1982ba633
commit 4b10027437
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -1,14 +1,14 @@
# Unalike
A lobby manager IRC bot (Python) and web interface (PHP) that enables playing multiplayer with friends on different difficulties.
A lobby manager by [Thayol][thayol-osu-url] with an IRC bot (Python) and a web interface (PHP) that enables playing multiplayer with friends on different difficulties.
Live demo at [zovguran.net/Unalike][Unalike-URL]. (It might be broken sometimes because it's what I'm actively modifying.)
I know it's a bit messy but I wasn't planning on releasing the code. Initially, I wanted to make it open-source because of the [Bot Account System][osu-bot-account-forum] proposed by Peppy, but after testing it thoroughly, I have come to the conclusion that it is perfectly fine to run from user accounts.
I know it's a bit messy but I wasn't planning on releasing the code. Initially, I wanted to make it open-source because of the [Bot Account System][osu-bot-account-forum] proposed by Peppy, but after testing it thoroughly, I have come to the conclusion that it is perfectly fine to run from user accounts. Take this as a proof-of-concept and use it as-is or base your own version on it.
The plan was to make it Python only, as it has built-in support for poviding a dedicated web server service, but in the end I fell back to my well known PHP knowledge.
By the way, I'm [Thayol][thayol-osu-url], feel free to ask me any questions anywhere.
Even though I doubt this would be easy to develop without a complete rewrite, pull requests are welcome! Feel free to ask me any questions anywhere.
## Features
setup_help/README.md
+3 -3
View File
@@ -16,14 +16,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.
- 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.
- 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`
- Change the $local_secret variable's contents to a secure and preferably long string of numbers and letters.
- 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.)*