Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpeta/pesterchumonlinebutsilly
A static pure-JavaScript Pesterchum client (it's a bit too goofy and silly)
https://github.com/dpeta/pesterchumonlinebutsilly
homestuck irc pesterchum
Last synced: 2 months ago
JSON representation
A static pure-JavaScript Pesterchum client (it's a bit too goofy and silly)
- Host: GitHub
- URL: https://github.com/dpeta/pesterchumonlinebutsilly
- Owner: Dpeta
- License: agpl-3.0
- Created: 2023-01-22T12:21:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T15:23:42.000Z (9 months ago)
- Last Synced: 2024-03-20T16:41:41.546Z (9 months ago)
- Topics: homestuck, irc, pesterchum
- Language: JavaScript
- Homepage: https://pesterchum.online
- Size: 11.8 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PesterchumOnlineButSilly
A static pure-JavaScript Pesterchum client; not to be confused with the 2014 NodeIRC/Heroku 'Pesterchum Online'!!
Pretty much the only thing I've ever made using JavaScript, so it's really not very good. Hopefully at least passably secure though; all content from the server is escaped and the live server has a fairly strict content security policy. ([CSP Evaluator](https://csp-evaluator.withgoogle.com/?csp=https://pesterchum.online))
An important difference between this and previous PCO clients is that this client is fully client side and connects over a WebSocket connection, this means that:
- The hosting server only needs to serve static content.
- The hosting server won't act as a proxy, so banning a PCO user will actually ban the user instead of the PCO server like with the previous clients.
Even if this client is kinda bad; it's probably best if future online clients also use a WebSocket connection now that IRC is gaining support for it, it's better than the PCO server having to proxy all messages.
To connect to a server other than irc.pesterchum.xyz just swap out the address in ``src/pesterchum.js``.
## Local setup
Just download and open index-src.html, the site is fully static so there's no further setup :3
## Setup for web server (without babel)
```sh
mkdir dist
cp src/pesterchum.js dist/pesterchum.js
cat dist/pesterchum.js | openssl dgst -sha256 -binary | openssl base64 -A
```
Afterwards you have to put the resulting hash of the script into the integrity fields in index.html's script/preload tags, and ideally also add it to the server's content security header.
## Setup for web server (with babel)
Lets the client run on evil old browsers 3
Install dependenies.
```sh
npm install @babel/core @babel/cli @babel/preset-env browserify core-js babelify
```
Run source through browserify + babel, equivalent to running bundle.sh:
```sh
./node_modules/.bin/browserify src/pesterchum.js -o dist/pesterchum.js -t babelify
cat dist/pesterchum.js | openssl dgst -sha256 -binary | openssl base64 -A && echo
```
Then input the resulting hashes, same as the previous setup.
# Contributing
> [!NOTE]
> This section still WIP
Before sending a pull request, if you modified the `/src/pesterchum.js` file, please run
`npm run lint`
This will run ESLint (``eslint --fix``) and automatically fix problems and enforce style guidelines.
## Thanks to:
All the artist collaborating with backgrounds:
- paleWreath
- AU Dave
- Caliborn (Pure art skills!)