Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roerohan/passwordgame
Backend for Password game.
https://github.com/roerohan/passwordgame
backend express password-game socket-io typescript
Last synced: about 1 month ago
JSON representation
Backend for Password game.
- Host: GitHub
- URL: https://github.com/roerohan/passwordgame
- Owner: roerohan
- License: mit
- Created: 2020-05-02T12:40:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T16:03:42.000Z (about 2 years ago)
- Last Synced: 2023-03-03T06:49:20.319Z (almost 2 years ago)
- Topics: backend, express, password-game, socket-io, typescript
- Language: TypeScript
- Size: 362 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PasswordGame
Backend for Password game.
Frontend Repo: https://github.com/roerohan/Password
# API
> Note: `?param` implies `param` is optional.
> Note: Format: \ \ - \
- All routes return a JSON with the following format:
```typescript
{
success: boolean,
message: string | object,
}
```
- `success` indicates if a request passed or failed.
- `message` indicates why a request failed, or stores the response if the operation was successful.
## /room
- `POST /room/create - username, ?access, ?rounds`
* Create a room with creator as `username`.
* `access` determines the type of room, may be `private` or `public`.
* `rounds` implies the number of rounds in the game.
* Returns the `roomId` and `creator` in the response JSON.
```typescript
{
success: boolean,
message: {
roomId: string,
creator: string,
players: [
{
username: string,
points: number,
},
],
},
}
```
- `GET /room/join/:roomId - username`
* Add user `username` to the room.
* Returns a JSON of the following format:
```typescript
{
success: boolean,
message: {
roomId: string,
creator: string,
hasStarted: boolean,
player: {
username: string,
points: 0,
}
players: [
{
username: string,
points: number,
},
{
username: string,
points: number,
},
],
},
}
```
## /game
- `POST /game/start - username, roomId, ?access, ?rounds`
* `username` must be the creator of the room.
* Modifies access and rounds according to `access` and `rounds`.
* Starts the game for room `roomId`.
* Returns a JSON of the following format:
```typescript
{
success: boolean,
message: {
hasStarted: boolean,
rounds: number,
currentRound: number,
players: [
{
username: string,
points: number,
},
{
username: string,
points: number,
},
],
},
}
```
- `POST /game/next - roomId, username`
* Generates a new password in the backend for the room, returns the new passwordHolder and the length of the new password.
* `currentPassword` is sent only when the `username` is the same as the `passwordHolder`.
* Returns a JSON of the following format:
```typescript
{
success: boolean,
message: {
currentRound: number,
rounds: number,
passwordHolder: string,
passwordLength: number,
previousPassword: string,
currentPassword: string,
roundEnd: number,
players: [
{
username: string,
points: number,
},
{
username: string,
points: number,
},
],
},
}
```
- `POST /game/hint - roomId, username, hint`
* Adds the hint to the `hints` array for the current round.
* Returns a JSON of the format:
```typescript
{
success: boolean,
message: {
hints: array,
passwordHolder: string,
},
}
``
- `POST /game/end - roomId`
* Ends the game for `roomId`.
* Deletes data pertaining to `roomId`.
* Returns a JSON of the form:
```typescript
{
success: true,
message: {
players: [
{
username: string,
points: number,
},
{
username: string,
points: number,
},
],
},
}
```
# Socket Events
- join
- message
- start
- hint
- disconnect