yuLEp5i6

1# Ultimate Hub
2
3For One Night Ultimate Werewolf.
4
5## ABOUT
6
7+ **What:** Ultimate Hub is a website designed to create an online gaming experience of the popular social deduction card game, _One Night Ultimate Werewolf_.
8+ **How:** The website is constructed with Node.js, Express, Socket.io, JS, HTML and CSS.
9+ **Why:** The website was made to fulfill the lack of sites designed for playing the game, and to create an enjoyable and user-friendly experience, within a community full of contributive and rich activity.
10
11## FEATURES
12
131. The website's structure is **Lobby Based**, in other words, there exists a lobby in which you can create **Tables**. The tables are confined sites, in which games develop independently from other tables. The lobby will also give you access to view and to enter other tables.
142. The website's users communicate through **Chat Rooms**. First, there exists the global chat room, in which you can talk to every player online. Second, every table has a private chat room, in which you can only talk to every player inside of the table. (WIP)
153. The website provides clear **Audiovisual Interactions**, with a clean aesthetic and clear UI design, animations to make the game understandable and approachable, and sound effects to alert the players of important actions within the game. (WIP)
164. The website utilizes **User Registers** for managing the clients. (WIP)
17
18## STRUCTURE
19
20The code is divided into separate folders for each module:
21
22### Backend Folder
23
24The Backend Folder will exclusively consist only of modules that affect routing, packaging and communication of the app directly.
25
26+ The **Express Module** goes inside this folder.
27+ The **Socket.io Module** goes inside this folder.
28
29### Main Folder
30
31The Main Folder will consist of all the remaining content of the game.
32
33+ All HTML files go inside this folder.
34+ Subfolder:
35	1. **Javascript Folder**: All Javascript files go inside this folder. If any subfolder here is named after any previous HTML documents, All Javascript files used on that HTML document go inside this folder. All Javascript files, used on all the HTML document, go inside the folder _utils_.
36	2. **CSS Folder**: All style sheets go inside this folder.
37	3. **Image Folder**: All images and sprites go inside this folder.
38
39## INSTALLATION
40
41The installation for this project is a default Node.js set up.
42
431. Run `npm install`.
442. Run `npm start`.
453. Start prototyping.
46
47## CONTRIBUTING
48
49All details for contributing go inside the CONTRIBUTING.md file.
50_Read CONTRIBUTING.md._
51
52## LICENSE
53
54All details of the license go inside the LICENSE file.
55_Read LICENSE._
56
57All image rights belong to Bezier Games.
58This project has no funds, and no intention of monetization.
59
60## FEEDBACK
61
62All Feedback will be well received.
63Make sure to create issues on the issues page for any bugs, error, corrections or suggestions.
64
65## COMMENTS
66
67This project was made in spare time. I do not belong to any organization.
68To communicate with me, email me at *connecticat@protonmail.com*.