Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 4.34 KB

README.md

File metadata and controls

105 lines (72 loc) · 4.34 KB

WithB

An IRL interactive roleplay game to learn how to cheat on your relatives.

Who is that ho* Bryan ?!

Rules

  1. Each player is randomly associated with 2 people who they are in a relationship with.He/she knows who she is with but is the only one to know with like if you were part of a circle where you only know the person on your right and your left.

  2. Each player is also given 5 random personality traits with at least one in commun with both persons he/she is with.

  3. You (and your relations) have to guess with whom they are being cheated on with.

  4. When you think you figured out who is one of your partners tchetting you on with you can try to take a hint and hit the buzz button. Be careful you only get 3 trials.

  5. At any time, the game masters can decide to spice things up by giving you missions or minigames in order to give some people some bonuses or maluses depending on the outcome of the game. Those “events” will appear on the website so you need to have an eye on it at all times.

Example

This is an example of a solution, only the game knows this graph. Here, there are 5 people playing.

What (only) the game sees

What Léo will see

In this example, Léo has to find with whom Marie is cheating on him (the answer is Maël) and with whom Meziane is cheating on him too (the answer is Enora)

Meziane has to find with whom Léo is cheating on him (Marie) and with whom Enora is cheating on him too (Maël).

The capital letters are personal traits. You have at leats 1 common trait with a person you are in a relationship with.

Contributing

Installation

  • You need NodeJs (tested on v15)
  • Clone the repository and navigate to the folder
  • Install the dependencies : npm install
  • Run the development server : npm run dev
    • If nodemon crashes, you might install ts-node globally : npm i -g ts-node or upgrade to NodeJs 15+.
  • Navigate to http://localhost:8080/ or run the test script

Testing

You can simulate a game with 10 players and see both the manager and the player view.

  • Run the test script to create a fake game : npm run test

App structure

The whole project is a single express.js server. You can create and operate with multiple games in parallel with only 1 instance running.

  • /src
    • index.ts - App entrypoint, starts the server
    • router.ts - Determines the behavior of the server according to the URL of the request
    • game.ts- Class that encapsulates the data and methods of a single running game
    • generator.ts - A toolbox/helper to generate the graph
    • io.ts - Socket.io specific server behaviors. Add here in-game interactions between the server and the client.
    • /views
      • join.html - Landing interface
      • manager.html - Game manager interface
      • player.html - Player interface

Adding rules/behaviours

The socket.io library allows to exchange messages between the server and clients (game player, game manager). Learn more on the socket.io documentation

When a player joins a game, his web browser loads the player.html file (as defined in router.ts). This html files includes the socket.io script of our server.

<script src="/socket.io/socket.io.js"></script>
<script>
    // Open socket.io connection and parse URL to get gameId and nickname
    const socket = io()
</script>

The browser of the player will now execute the script and create socket.io connection with the server. You can interact and send/receive messages through this connection using the socket variable.

client:

// Notify the server that we are part of a specific game
socket.emit('joinRoom', gameId);

This commands emits a joinRoom event with a content (gameId), those informations will be catched by the server in the io.ts file.

server:

socket.on('joinRoom', room => { // room = gameId
    // Get the corresponding game if it exists, else leave
    if (!checkExists(games, room, socket)) return
    socket.join(room)
})

And that's all, you can now create your own interactions by adding socket.emit and socket.on on both server side (the io.ts file) and the client side (player.html and manager.html)