First install

1. Download
2. Run 3DXChat.exe from the folder "3DXChat 390 (v.068)"

Few notes
The client has common settings with the official client. If you see your mail from the official client in the login-password field - do not be alarmed, this data is not transmitted to the server in any way.

Client Files
peppersprayPlugin / config.xml - configuration from IP servers

Server consists of a number of components:

pepperspray application, which fires up three of the five required services (chat server, REST API server and login server)
pepperspraySocketIOProxy, which proxies login requests to the previous component's login server (required for the game client to be compatible)
peppersprayWeb, a web front, which is used to create user accounts in order to login to pepperspray. Uses it's API server, doesn't have any backend on itself

pepperspray application
Configuration

Application require configuration files to be present in ./peppersprayData, if you install it from a release then example folder will already be there. Structure is as follows:

./database - sqlite database
./logs - server logs
./presets - base64 default character + virtual partner presets
./worlds - user worlds with default one named default.world
./configuration.xml - configuration file
./news.txt - announcements that are shown at login screen

configuration.xml format

XML file contains comments describing what each option does. Important bits are which ports will the whole thing run:

chat-server/addr is an address for chat server (should match game's config)
rest-api-server/addr is an address for rest API server (should match game's config as well as peppersprayWeb config)
rest-api-server/world-cache will determinate capacity for RAM world cache (number of worlds cached)
rest-api-server/cross-origin will provide headers for cross-origin access. This should match address and port of the peppersprayWeb, in order for browser to allow cross-origin requests
rest-api-server/mail provides mail client configuration in order to send new passwords for Forgot password function of the web site
login-server/addr is an address for login server (should match pepperspraySocketIOProxy configuration, but not game's!)

Any ip field can have auto value, server will then use DNS in order to determine current server IP. If console output doesn't match your expected address you should change all autos to actual IP address.
news.txt format

Each announcement consist of 4 fields, conjoined by | - title, text, image and url. Later two can be omitted (providing empty text but still keeping the |), image should be hosted under /static/news/images/, otherwise it will not load. You can add as many news as you like just by adding more fields to it.

You can use following html tags in the text -
, , .
Deploying

Windows: fire up pepperspray.exe executable.
Linux: install mono and run it as follows: mono --server pepperspray.exe.

Application will create sqlite database on startup (in peppersprayData/database), and will write detailed logs to peppersprayData/logs (roll-over at midnight).

Only limited information will be put out to the console, logs contain much more info and generally speaking you should look for errors in there (and submit relevant parts if you create an issue here).
pepperspraySocketIOProxy application
Configuration

Open app.js and edit ADDRESS and PORT to match your pepperspray login server. Port for the proxy itself is determined on the last line of the file, this should match to the clients login server configuration).
Deploying

Install node.js and run it via node app.js. Proxy will log its connections to the app.log.
peppersprayWeb site
Configuration

You must provide url of the pepperspray REST API server in the peppersprayWeb/src/services/UserService.js, and build the site using node run build. Resulting static files will be compiled under ./dist folder.
Deploying

Serve those files from any web server you fancy. Keep in mind that the address and port of that server should match ones you set in pepperspray configuration's cross-origin node, otherwise requests will not go through.