Update 'trunk'

Mute 2022-11-12 13:16:53 +00:00
parent 36b5c8aeaf
commit 36be5e8234

114
trunk.md

@ -1,116 +1,6 @@
# Mute's Bondage Club Hacks Collection
Trunk version.
## 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.
## Current user-visible changes over unstable
## 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.
* Removed handheld penetration patch. We'll see if it returns after R86 release.
On the other hand, if you want to control the script versions yourself, don't use the loader. Trunk version doesn't come with a loader because you should be comfortable to overcome this obstacle before using it.
## 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
The idea is to have a bookmark with custom code and click it while on the game page. Refer to excellent manual on [BCE page](https://sidiousious.gitlab.io/bce/), just replace BCE's code with one of the following.
## 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
* Bookmarklet: ```javascript:(()=>{fetch(`https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc.user.js?ts=${Date.now()}`).then(r=>r.text()).then(r=>eval(r))})()```
### `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
* Bookmarklet: ```javascript:(()=>{fetch(`https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-dev.user.js?ts=${Date.now()}`).then(r=>r.text()).then(r=>eval(r))})()```
### `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
### Static improvements
#### MBCHC indicator
A colour square up top. Blue means their version is the same as yours, red means they differ.
#### Local time
Two digits in the indicator space show the current hour of the character. Parses the profile (looks for strings like GMT+10 or utc-8) or remembers the `/mbchc tz` input (see below). If your time is 16:37 and you see "19" over someone, it means their local time is 19:37.
#### Handheld objects penetration
Select handheld objects were modified to allow penetration actions.
#### Better chat history
PgUp/PgDn scrolling now a) doesn't lose your input, b) doesn't log the same input in succession, c) blinks when there are no more lines remembered, d) will treat existing input as search prefix.
#### BCE patch
If the item is locked, the tighten/loosen feature is unavailable on it. Also autocomplete for /pose and /anim commands.
### New chat commands
#### /mbchc versions
Shows the MBCHC versions across the room.
#### /mbchc 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.
#### /mbchc autohack
Toggles the 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.
#### /mbchc donate [[TARGET]]
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.
#### /mbchc tz OFFSET \[ [[TARGET]] \]
Set local time for the character. Offset is from UTC, not your time. Valid offsets are integer numbers from -12 to 12. Doesn't care for DST, adjust manually.
Example: if your local time is UTC+5, and you know that Name is 8 hours behind you, use the command like this: `/mbchc tz -3 Name`.
#### /mbchc title TITLE
Set a custom title. Currenty only works with the same titles you can select. **Work in progress.**
#### /mbchc purge!
Deletes all your MBCHC settings from the server.
#### /do VERB \[ZONE\] \[ [[TARGET]] \]
Send an activity, as if clicked on its button. See [[its own page|do command]].
#### /activity TEXT (or `@@TEXT`, or `@TEXT` as yourself)
Send a custom activity. Examples: `@@it starts to rain` will send `(It starts to rain.)`; `@shivers` will send `(YourName shivers.)`.
Optionally makes use of club's advanced functionality, if prefixed with characters like this: `<[MemberNumber]:[MemberNumber]> Text`. First member is `SourceCharacter` and second is both `TargetCharacter` and `DestinationCharacter`, the difference best shown on examples:
* `SourceCharacter creates a duct tape skirt on TargetCharacter and traps her hands in it.` ("on Mute")
* `SourceCharacter wraps duct tape around DestinationCharacter hands.` ("Mute's hands")
### Console goodies
* `MBCHC.LOG_MESSAGES = true` will log most of received messages, notable exception being BCX ones.
* `MBCHC.RETHROW = true` will let you see exceptions thrown during command execution in addition to them being shown as chat messages.
## 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.