mute/MBCHC
1
0
Fork 0
Code Issues Releases 1 Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
Mute 2023-06-18 02:15:22 +00:00
parent e4f7ce0560
commit ff377fb709
1 changed files with 2 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
README.md
View File

@ -2,97 +2,6 @@
This document is updated with stable releases, for additional documentation please consult [[the wiki|https://code.fleshless.org/mute/MBCHC/wiki/Home]].
* Unstable doc: https://code.fleshless.org/mute/MBCHC/wiki/unstable
* Trunk doc: https://code.fleshless.org/mute/MBCHC/wiki/trunk
## Stable vs. unstable versions
Stable version is updated less often and after some testing. Hopefully it contains less bugs, but also is behind on new features. By the same token, unstable version is updated more often and with minimal testing by the authors. Think of it as beta versions of the club. Trunk version is the least tested and the most updated.
## Loader scripts
These download the corresponding main script, making sure it's always fresh. Most Tampermonkey users should probably use the loader instead of adding the main script directly. Tampermonkey has an update check, but loaders are just more convenient if you want to always have the current version.
On the other hand, if you want to control the script versions yourself, don't use the loader.
## Installation
### BCE integration
None at the moment. Please ask BCE devs to add MBCHC loading if you want to have it (seems like a good idea to us).
### Tampermonkey
1. Install Tampermonkey.
2. Select a script you want to add below, then click its URL.
3. Tampermonkey should recognise the script and prompt you for installation.
4. Refresh the club page and enjoy.
### Bookmarklet
(Doesn't work just yet, will be supported in the next release.)
## Scripts
### `mbchc-loader.user.js`
The loader script for the stable version (**if unsure, use this**).
URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-loader.user.js
### `mbchc.user.js`
The main script, stable version.
URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc.user.js
### `mbchc-loader-dev.user.js`
The loader script for the unstable version (**use this if you want to help testing**).
URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-loader-dev.user.js
### `mbchc-dev.user.js`
The main script, unstable version.
URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-dev.user.js
### `mbchc-local.user.js`
The main script, trunk version. (**use this if you really want the latest**).
URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-local.user.js
## Features
These are new commands this mod adds, use `/help` for syntax.
### /disappear
This command will make you invisible, if you are wearing an anal hook tied to hair.
You might also want to consider hiding your arousal meter.
### /autohack
Toggles an autohack mode. Currently this mode starts hacking again as soon as the data gets stolen.
Be informed that autohacking is much less lucrative due to game mechanics. No plans to "fix" this.
### /donate
Buy data on the black market and send it to someone. Serves as money transfer. Doesn't require anything from the other party except from being restrained. Data will cost you more than it will make, this is by design.
### /nod
Send a nod activity, as if clicked on the button.
### /shake
Send a headshake activity, as if clicked on the button.
### /shrug
Send a shrug activity.
### /myself (or @)
Send a custom activity as yourself. Example: "@shivers" will send "(YourName shivers.)"
### /activity (or @@)
Send a custom activity. Example: "@@it starts to rain" will send "(It starts to rain.)"
### /title
Set a custom title. Currenty only works with the same titles you can select. **Work in progress.**
## Geek corner
Yes, we are aware of all the nifty git features (branches etc.), we just don't use them.
This mod is low effort, just enough to work without errors and deliver features we find useful.
We also have to keep in mind not everyone in the club works in software development, so it needs to be
as user-friendly as possible.
## Contributing
Sure, welcome onboard. Please send pull requests, patches, ideas, feedback, feature requests and bug reports.
## Contacts
Beyond social functions this site provides, you can always find us in the club or drop us an email. We don't use discord.
## PSA
The only supported version is unstable, don't use any other.