From f71925fbe26ccb223178ba8e3ad8d62fad07ef52 Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Sun, 15 Sep 2024 15:31:35 -0500 Subject: [PATCH 01/11] add jank client --- docs/setup/clients/index.md | 2 + docs/setup/clients/jank/index.md | 5 +++ docs/setup/clients/jank/web.md | 70 ++++++++++++++++++++++++++++++++ 3 files changed, 77 insertions(+) create mode 100644 docs/setup/clients/jank/index.md create mode 100644 docs/setup/clients/jank/web.md diff --git a/docs/setup/clients/index.md b/docs/setup/clients/index.md index b8f9a19..fe45f39 100644 --- a/docs/setup/clients/index.md +++ b/docs/setup/clients/index.md @@ -1 +1,3 @@ ## [Official Client](official) + +## [Jank Client](jank) diff --git a/docs/setup/clients/jank/index.md b/docs/setup/clients/jank/index.md new file mode 100644 index 0000000..95b03f0 --- /dev/null +++ b/docs/setup/clients/jank/index.md @@ -0,0 +1,5 @@ +# Jank Client + +Jank client currently only has 1 version: + +- The web version which is currently under active development. [Web Client](web.md) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md new file mode 100644 index 0000000..1d27150 --- /dev/null +++ b/docs/setup/clients/jank/web.md @@ -0,0 +1,70 @@ +# Web Jank Client + +!!! warning "Jank client is under heavy development and not ready to be used in production yet." + +Jank client is currently being developed at [this repository](https://github.com/MathMan05/JankClient). + +## Official host + +Jank Client was hosted at [this host](https://sb-jankclient.vanillaminigames.net/) but recently, the person who was hosting it has gone away, so for now there is no official host. + +!!! note + + Jank client does support pointing to by default your own instance, you can read about it [here](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md) + +!!! warning + + If you want you instance to play nice with other instances of Jank Client using their account switchers, you need to disable CORS, or allow requests from the instances of Jank Client you trust + +## Setup/Building + +### Dependencies + +- [Git](https://git-scm.com/) +- [NodeJS](https://nodejs.org) or [Bun](https://bun.sh/) + +In your terminal: + +```bash +# Download {{ project.name }} Client +git clone https://github.com/MathMan05/JankClient.git + +# Enter the cloned directory +cd JankClient + +# Install dependencies +npm install + +# Or if you're on bun +bun install +``` + +To start the client, run + +```bash +./index.js + +# Or if you want to more explicitly run it with nodejs +node ./index.js + +# If you're using bun +bun ./index.js +``` + +If you're wanting to also develop Jank Client, you'll need to start the type script compiler in watch mode on the base dir of the project. + +## Contributing + +To contribute: + +- Fork (Jank Client)[https://github.com/MathMan05/JankClient] +- Run the building instructions. +- Commit & push. +- Pull request & done! + +### What can I contribute? + +- More settings, and general bug fixes, CSS improvements or anything you think needs to be fixed/improved +- [This](https://github.com/users/MathMan05/projects/1/views/1) is a good list for things that need to be done, though it's incomplete, so if you think something is missing and you want to add it, just do it! MathMan05 is more than willing to answer your questions if you have any! +- Even if you can't code, there's stuff you can still do! Like [reporting bugs](https://github.com/MathMan05/JankClient/issues), or updating the documentation! Even if you don't help Jank Client directly, if you contributed to the Spacebar server itself, it'd still be a huge help towards Jank Client, especially if you improve/fix op codes 8/14. +- If you have an instance you can put it on Jank Clients [instance list](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md), if you don't it'll show up on Jank Client if it's on the official instance list, but it's good if you do put it on the list as it'll let Jank Client have some additional information, and your instance will be higher on the list, even if you partially fill it out, Jank Client will merge both listings so no information is lost. From 7b6ea9ef4cf6f84aee40a27a1d3be28ab5b2780b Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Sun, 15 Sep 2024 15:37:39 -0500 Subject: [PATCH 02/11] add port note --- docs/setup/clients/jank/web.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 1d27150..6561f84 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -50,6 +50,9 @@ node ./index.js # If you're using bun bun ./index.js ``` +!!! note + + Jank Client defualts to opening on port 8080, if you want to change the port you'll need to change either the env variable PORT or put the port on the command you run so it'd be like node ./index.js 43 If you're wanting to also develop Jank Client, you'll need to start the type script compiler in watch mode on the base dir of the project. From d49c4d38ab39157ffb0f667331cd8a4fbba9bfab Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Mon, 16 Sep 2024 16:34:57 -0500 Subject: [PATCH 03/11] update situation --- docs/setup/clients/jank/web.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 6561f84..24e5391 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -6,7 +6,7 @@ Jank client is currently being developed at [this repository](https://github.com ## Official host -Jank Client was hosted at [this host](https://sb-jankclient.vanillaminigames.net/) but recently, the person who was hosting it has gone away, so for now there is no official host. +Jank Client is hosted at [this host](https://sb-jankclient.vanillaminigames.net/) though this arrangment may change to make [this](https://jankclient.greysilly7.xyz/) the official host instead, there's currently a bit of a complicated situation with the hosting of jank client. !!! note From 5d3e05ba92281a40c3f712373ef087be464ada73 Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Thu, 19 Sep 2024 14:10:58 -0500 Subject: [PATCH 04/11] update documentation --- docs/setup/clients/jank/web.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 24e5391..3a24f15 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -33,22 +33,28 @@ git clone https://github.com/MathMan05/JankClient.git cd JankClient # Install dependencies -npm install +npm i # Or if you're on bun -bun install +bun i +``` +then build the client + +```bash +npm run build + +#or if you're on bun +bun run build + ``` To start the client, run ```bash -./index.js - -# Or if you want to more explicitly run it with nodejs -node ./index.js +npm run start # If you're using bun -bun ./index.js +bun run start ``` !!! note From dcd7f3e3ea27cffa295402cc21ba4d91ead90409 Mon Sep 17 00:00:00 2001 From: MathMan05 <73901602+MathMan05@users.noreply.github.com> Date: Fri, 20 Sep 2024 22:17:38 -0500 Subject: [PATCH 05/11] Update docs/setup/clients/jank/web.md Co-authored-by: Puyodead1 --- docs/setup/clients/jank/web.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 3a24f15..6e8844d 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -10,7 +10,7 @@ Jank Client is hosted at [this host](https://sb-jankclient.vanillaminigames.net/ !!! note - Jank client does support pointing to by default your own instance, you can read about it [here](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md) + Jank client supports pointing to your own instance by default, you can read about it [here](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md) !!! warning From 6ae4d45e251b7fd1ddfaaa1a415c5d6d83cba32f Mon Sep 17 00:00:00 2001 From: MathMan05 <73901602+MathMan05@users.noreply.github.com> Date: Fri, 20 Sep 2024 22:18:04 -0500 Subject: [PATCH 06/11] Update docs/setup/clients/jank/web.md Co-authored-by: Puyodead1 --- docs/setup/clients/jank/web.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 6e8844d..f851034 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -60,7 +60,7 @@ bun run start Jank Client defualts to opening on port 8080, if you want to change the port you'll need to change either the env variable PORT or put the port on the command you run so it'd be like node ./index.js 43 -If you're wanting to also develop Jank Client, you'll need to start the type script compiler in watch mode on the base dir of the project. +If you're wanting to also develop Jank Client, you'll need to start the typescript compiler in watch mode on the base directory of the project. ## Contributing From da179f99d6910c64a54108a502b1076856167e09 Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Fri, 20 Sep 2024 22:21:11 -0500 Subject: [PATCH 07/11] fix --- docs/setup/clients/jank/web.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 3a24f15..8ee1e4e 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -58,7 +58,7 @@ bun run start ``` !!! note - Jank Client defualts to opening on port 8080, if you want to change the port you'll need to change either the env variable PORT or put the port on the command you run so it'd be like node ./index.js 43 + Jank Client defualts to opening on port 8080, if you want to change the port you'll need to change either the env variable PORT or put the port on the command you run, ex: `npm start ./index.js 43` If you're wanting to also develop Jank Client, you'll need to start the type script compiler in watch mode on the base dir of the project. From e2daa1df54435c857f7102525fec662a77042555 Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Sun, 22 Sep 2024 18:15:06 -0500 Subject: [PATCH 08/11] update --- docs/setup/clients/jank/web.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 94df822..aeef5df 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -6,7 +6,7 @@ Jank client is currently being developed at [this repository](https://github.com ## Official host -Jank Client is hosted at [this host](https://sb-jankclient.vanillaminigames.net/) though this arrangment may change to make [this](https://jankclient.greysilly7.xyz/) the official host instead, there's currently a bit of a complicated situation with the hosting of jank client. +Jank Client is officially hosted [here](https://jankclient.greysilly7.xyz/) !!! note From 4d8902f9fdd204213417a6490cabb0e49fc48e19 Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Sun, 22 Sep 2024 18:19:08 -0500 Subject: [PATCH 09/11] fix name --- docs/setup/clients/jank/web.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index aeef5df..c675694 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -26,7 +26,7 @@ Jank Client is officially hosted [here](https://jankclient.greysilly7.xyz/) In your terminal: ```bash -# Download {{ project.name }} Client +# Download Jank Client git clone https://github.com/MathMan05/JankClient.git # Enter the cloned directory From 39d0d283d4e4de66eee0c3452481414189562307 Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Mon, 23 Sep 2024 08:31:07 -0500 Subject: [PATCH 10/11] clarity --- docs/setup/clients/jank/web.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index c675694..600978b 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -58,7 +58,7 @@ bun run start ``` !!! note - Jank Client defualts to opening on port 8080, if you want to change the port you'll need to change either the env variable PORT or put the port on the command you run, ex: `npm start ./index.js 43` + Jank Client defualts to opening on port 8080, if you want to change the port you'll need to change either the env variable PORT or put the port on the command you run, ex: `npm start ./dist/index.js 43` If you're wanting to also develop Jank Client, you'll need to start the typescript compiler in watch mode on the base directory of the project. @@ -76,4 +76,4 @@ To contribute: - More settings, and general bug fixes, CSS improvements or anything you think needs to be fixed/improved - [This](https://github.com/users/MathMan05/projects/1/views/1) is a good list for things that need to be done, though it's incomplete, so if you think something is missing and you want to add it, just do it! MathMan05 is more than willing to answer your questions if you have any! - Even if you can't code, there's stuff you can still do! Like [reporting bugs](https://github.com/MathMan05/JankClient/issues), or updating the documentation! Even if you don't help Jank Client directly, if you contributed to the Spacebar server itself, it'd still be a huge help towards Jank Client, especially if you improve/fix op codes 8/14. -- If you have an instance you can put it on Jank Clients [instance list](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md), if you don't it'll show up on Jank Client if it's on the official instance list, but it's good if you do put it on the list as it'll let Jank Client have some additional information, and your instance will be higher on the list, even if you partially fill it out, Jank Client will merge both listings so no information is lost. +- If you have a Spacebar instance you can put it on Jank Clients [instance list](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md), if you don't it'll show up on Jank Client if it's on the official instance list, but it's good if you do put it on the list as it'll let Jank Client have some additional information, and your instance will be higher on the list, even if you partially fill it out, Jank Client will merge both listings so no information is lost. From 89f1ba853ae68339f90e52bf423d2fe624f1d19c Mon Sep 17 00:00:00 2001 From: MathMan05 Date: Mon, 23 Sep 2024 08:35:50 -0500 Subject: [PATCH 11/11] just relized what rory wanted --- docs/setup/clients/jank/web.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/clients/jank/web.md b/docs/setup/clients/jank/web.md index 600978b..cd28626 100644 --- a/docs/setup/clients/jank/web.md +++ b/docs/setup/clients/jank/web.md @@ -76,4 +76,4 @@ To contribute: - More settings, and general bug fixes, CSS improvements or anything you think needs to be fixed/improved - [This](https://github.com/users/MathMan05/projects/1/views/1) is a good list for things that need to be done, though it's incomplete, so if you think something is missing and you want to add it, just do it! MathMan05 is more than willing to answer your questions if you have any! - Even if you can't code, there's stuff you can still do! Like [reporting bugs](https://github.com/MathMan05/JankClient/issues), or updating the documentation! Even if you don't help Jank Client directly, if you contributed to the Spacebar server itself, it'd still be a huge help towards Jank Client, especially if you improve/fix op codes 8/14. -- If you have a Spacebar instance you can put it on Jank Clients [instance list](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md), if you don't it'll show up on Jank Client if it's on the official instance list, but it's good if you do put it on the list as it'll let Jank Client have some additional information, and your instance will be higher on the list, even if you partially fill it out, Jank Client will merge both listings so no information is lost. +- If you have a Spacebar instance you can put it on Jank Clients [instance list](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md), if you don't it'll show up on Jank Client if it's on the [official instance list](https://github.com/spacebarchat/spacebarchat/tree/master/instances), but it's good if you do put it on the list as it'll let Jank Client have some additional information, and your instance will be higher on the list, even if you partially fill it out, Jank Client will merge both listings so no information is lost.