Skip to content

Commit

Permalink
Add unfinished README
Browse files Browse the repository at this point in the history
  • Loading branch information
Lieu Zheng Hong committed Jan 8, 2021
1 parent 995ffbf commit a538dae
Showing 1 changed file with 65 additions and 19 deletions.
84 changes: 65 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,65 @@
# Discord game

To run the game:
```sh
npm install
npm start
## visit http://localhost:8080
```
The game should look like this:
![nengi-2d-basic screenshot](./public/images/screenshot.png)

The renderer is PIXI v5, though the game doesn't do pixi any justice.

The controls are
- w - up
- a - left
- s - down
- d - right
- mousemove - look around
# Discord spatial layer

We built a multiplayer game that sits on top of any Discord server.
All users of a Discord server can hang out, move around, and chat
in real-time in a 2D virtual space.

## Introduction

In lieu of an actual childhood,
I fondly recall hanging out and chatting with my friends in Henesys Market
and fishing/cutting trees together in RuneScape's Draynor Village.

There's something uniquely magical about that sort of experience,
and I'm pretty sure it's not just the nostalgia talking.
There's a raw and real human need for connection
and this has been solved somewhat by chat/social apps
such as MSN Messenger, Telegram, and Discord.
But I've always felt that they never came close to the
fun I had just sitting around in the FM with my friends:
useful as they are, something is missing from these apps.

What is that *je ne sais quoi*? I believe it's _spatiality_
and _interactiveness_.
Hanging out in Maple or RS is especially compelling because
it has something more than just chat:
you can express yourself with your movement, fashion choices, your
skills, your facial emotions, and so on.
So we set out to build a spatial "layer" that sits on top
of the social apps we know and love.
We hope that people can use it to form and sustain
stronger and more lasting friendships over the Internet.

## Why would anyone use this? What is the point of it all?

There are lots of startups in this space like Gather Town,
but (in my opinion) they won't get much traction because they aim
to be a *tool*, not a *community*.
We want to build something that piggybacks on--supplants--the communities
already existing in groups like Discord and Telegram.
As to why not just play a game instead:
our spatial layer is really lightweight and doesn't require a download:
good luck getting the 1,000 people on your server to download 20GB of game.

## User flow

1. User installs the Google Chrome Extension
2. User navigates to the Discord web client
3. User clicks the extension; our bot DMs a secret to the user
4. User enters secret into our front end
5. User has joined the spatial layer and can move around, chat and use emojis.

## Technical details

We used a couple of libraries:

- Discord API for the Discord bot
- Nengi for the multiplayer networking
- PixiJS for the rendering engine

## Difficulties and things we've learned


## Extensions

We want to give more activities

0 comments on commit a538dae

Please sign in to comment.