From 7d12939c1e13c42901ba8b9255c04f7511cad1b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Wed, 7 Dec 2022 07:29:49 +0100 Subject: [PATCH 1/4] chore: README.md --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c837f8 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# sessions + +A browser extension aiming to simplify cooplaying in [Tribal Wars](https://www.tribalwars.net/en-dk/). Cooplayers can finally play at the same time via a browser! + +## Getting started + +### Development + +#### Set up the environment + +Prerequisites: + +1. **Node.js** (LTS) +2. **IDE/Code editor** (e.g. WebStorm, VSCode, vim, neovim) +3. **web-ext** (``yarn global add web-ext``) +4. **backend** (such as [this one](https://gitea.dwysokinski.me/twhelp/sessions)) +5. **Chromium-based browser** (e.g. Chromium, Vivaldi, Brave) + +```shell +# start a dev server +yarn watch + +# launch a browser (e.g. Chromium) +yarn run:chromium +``` + +## License + +Distributed under the MIT License. See ``LICENSE`` for more information. + +## Contact + +Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me) -- 2.45.1 From 5eedb55aa6c53b6b7d424968b089b486869c8c19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Fri, 9 Dec 2022 06:11:40 +0100 Subject: [PATCH 2/4] chore: README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c837f8..21d2752 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A browser extension aiming to simplify cooplaying in [Tribal Wars](https://www.t ### Development -#### Set up the environment +#### Setting up the environment Prerequisites: -- 2.45.1 From b1daf1bab2b93827e6b7caef47fbaef95587c31b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Fri, 9 Dec 2022 06:16:58 +0100 Subject: [PATCH 3/4] chore: README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 21d2752..11453b3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # sessions -A browser extension aiming to simplify cooplaying in [Tribal Wars](https://www.tribalwars.net/en-dk/). Cooplayers can finally play at the same time via a browser! +A browser extension aiming to simplify coplaying in [Tribal Wars](https://www.tribalwars.net/en-dk/). Coplayers can finally play at the same time via a browser! ## Getting started -- 2.45.1 From a1e109fa81c3457b435d7e922908d2ab93e21d29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Fri, 9 Dec 2022 06:34:39 +0100 Subject: [PATCH 4/4] chore: README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11453b3..a6cf538 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # sessions -A browser extension aiming to simplify coplaying in [Tribal Wars](https://www.tribalwars.net/en-dk/). Coplayers can finally play at the same time via a browser! +A browser extension aiming to simplify coplaying in [Tribal Wars](https://www.tribalwars.net/en-dk/). Coplayers can finally play together via a browser! ## Getting started @@ -24,6 +24,10 @@ yarn watch yarn run:chromium ``` +## FAQ + +1. What data are sent to the backend? - Only sid (session identifier). Sid is [encrypted/decrypted on the client side](./src/crypto.ts). + ## License Distributed under the MIT License. See ``LICENSE`` for more information. -- 2.45.1