A Discord bot for circl (a game-bot similar to Hacknet, concept by @taydev) in Node.js. This is our entry for the Discord Community Hack Week competition.
If you would like to see this in action, please join discord server;
- Unix-like navigation
- Hack servers like a pro
- Cool storyline with awesome ending
- 1-2 hours of gameplay
- Live actual webservers (which you can edit if you hack them)
- Tons of files to explore
- Run
$signupin any channel/DM to start
The bot consists of four main parts. The state machine, the filesystem, the quests and the scripts.
The state machine is simple. It's a machine that tracks states. It's used for non permanent information such as what server you're connected to or the file path of the current directory. Quite simple stuff but very powerful.
The filesystem was a bit harder. We decided on a JSON structure like below. We chose this system because it allowed us to go as deep as we wanted to, and allows us to have much more complex servers. We made fileUtils.explorePath() to recursively convert a path to a file/dir (and returning false if invalid). This made working with files a whole lot easier. With both statemachine and the file system in place, all the commands were just a matter of combining the functions into a .js file!
[
{
type: "dir",
name: "logs",
contents: [
]
},
{
type: "dir",
name: "bin",
contents: [
{
type: "file",
name: "porthack.exe",
contents: "content here"
}
]
}
]
The scripts are rather interesting. The executable files aren't hardcoded to execute code. Instead, we made all executable files have the contents defined by a constant and that constant would then run the code defined in scripts.js. So technically, if you copied the contents of the file on your clipboard, you could beat the game (by making a file and copying over the contents of an end-game files)!
The quests should have been easy; the idea was to just make a server list, and a quest list. Quests would have conditions to check if the requirements had been completed or not. The problem was with the filesystem - with the normal FS notation we made we would have 5 lines for every file/dir. That wasn't going to cut it if we wanted many quests. so we made a shortened file system that's parsed when a user makes an account. If it's set to false then it's an empty dir. If it's set to something then it's a file. All directories are made according to the path provided. This newly devised system shortened the notation by around 90%. Much better! You can view said notation below:
[
"/bin": false,
"/home/readme.txt": "In case you're reading this, you've hacked my pc. Could you please not? kthxbye.",
"/home/secret/secret.txt": "SWYgeW91IHRyaWVkIGZpbmRpbmcgYSBzZWNyZXQuIHlvdSd2ZSBmYWlsZWQu",
"/sys/node_modules/index.js": "const sys = require('linux');\nsys.boot();",
"/logs": false
]
The quests are all generated per user so you won't interfere with other users. This said, it is possible to give an IP to someone and they finish the quest for you. That means 38 servers generated per user.
We've made everything in VSCode Live Share. Every commit from @mrjvs is actually from all of us - we don't like merge conflicts so using Live Share was the best option for us.
You can check out the official Discord Hackweek server to find out more about the competition.
