aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 292dcd262acb2e9e8fefc182cbaf822980702606 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# worldsy
A Discord RPC client for [Worlds](http://worldsonline.com/).

![](./assets/screenshot.png)

# Why?
Honestly, I was bored...

I was just sitting at GroundZero, chatting, and I know that there is quite a big Discord server for Worlds and this idea popped into my head and I said "Why the heck not.".

I had to jump through some hoops to get this working as well, I had to learn Tkinter! Python isn't even ONE of my favourite languages so I made this while holding back tears.

### Why Python then?
Honestly, it was because it the right tool for the right job.

In the future, I might rewrite this in Rust or something but at the moment, it's fine.

Plus, I'd bet there's more Python developers out there than just about any other language so that's a plus.

### How much time did you spend writing this? 
Around three to four hours, without getting up, without looking away... I need help.

# Usage
1. Download the latest release from the [releases](https://github.com/fuwn/worldsy/releases/latest).
2. Run executable.
3. Click "Start RPC".

## Development
To get started with this project;

1. Clone the repository.
2. Install the dependencies via `pip install -r requirements.txt`.

To build an executable, execute `build.bat`.

Note that this is only tested on Windows 10, there is no guarantee that this will work on other operating systems but be my guest in trying.

## Roadmap
- [Worldsy](https://github.com/fuwn/worldsy/projects/1)
- ~~Worldsy (Rust Re-write)~~

## Notice
All rights go to Worlds.com for the images with the [/assets](./assets) directory.

### License
[MIT](./LICENSE)