Skip to content

User Manual

Halis BAL edited this page Dec 29, 2023 · 17 revisions

Table of Contents

1. Register/Login

2. Homepage

3. Recommendation

4. Promotion

5. Post

6. Game

7. Comment

8. Profile

9. Review

10. Forum

11. Annotation

12. Admin Functionality


Register/Login
  • When a guest user visits our website and decides to register into our application in order to use all of the functionalities we are providing, he/she can visit the top right corner and choose to register into our system.

  • User need to fill the relevant information into the redirected page in order to register succesfully.

  • After registering, user can login into our application using the email and password combination he/she provided in register page.

Homepage
  • After logging in user will be redirected to homepage where he/she can see the posts from the forums of the groups or games that user follows. Hence, every (logged in) user will see a different personalized homepage. User can interact with posts during surfing through homepage such as voting a post or taking a look at characters or achievements relevant to a post. (Background color indicates the type of a post. If a post is posted in a group forum it will have a yellow background and a greenish background if post is from a game forum.)

  • Needless to say, guest users will have a different homepage compared to signed in users. By default, guest user will be greeted with latest posts posted on game forums. User of course can define a different sorting criteria and sorting direction.

Recommendation
  • After logging in user will be redirected to homepage where he/she can see the recommended games and recommended groups presented to him/her on top of the homepage posts.

  • Recommended games that are presented to signed in user are consist of personalized selections based on the games that user follows. Same logic also applies to recommended groups where recommended groups are selected using the information obtained from the games that user follows and groups user is a member of. (Similarity score calculation is being calculated among games and groups)

  • Guest users will be greeted with most popular games and groups overall

Promotion
  • When user visits the "Games" tab of the website to observe the games overall, he/she will observe two randomly picked promoted games on top of the stack of other games. Idea behind promotion is presented for game developers (or producers) to advertise their games.

Post
  • When user visits the game page and "Forum" tab in the game page, he/she will see posts related to that game.

  • When user clicks "Add Post" in the posts page, he/she can fill the information about post and share it.

  • When user clicks "Read More" in the posts page, he/she can see the detail of the post and comments.

  • When user clicks pencil icon in the posts page, he/she can edit the title and description of the post.

Game
  1. Game Creation
  • In order to create games, an admin should first be logged in. Then the admin should go to admin page by using admin button in the top bar and click create game button.

Screenshot_20231229_122827

  • Then the admin needs to fill the information regarding game and click the create game button.

Screenshot_20231229_123449

  • A notification will pop up and the game will be created.
  1. Game Update
  • In order to update games, an admin should first be logged in. Then the admin should go to admin page by using admin button in the top bar and click update game button.

Screenshot_20231229_123538

  • Then the admin should select the game to be updated.

Screenshot_20231229_123610

  • Lastly the admins should change the fields that he/she wants it to be changed and keep the others untouched.

Screenshot_20231229_123702

  • A notification will pop up and the game will be updated.
  1. Game Removal
  • In order to delete games, an admin should first be logged in. Then the admin should go to admin page by using admin button in the top bar and click delete game button.

Screenshot_20231229_123830

  • Then the admin should select the game to be deleted and click on delete game button.

Screenshot_20231229_123856

  • A notification will pop up and the game will be deleted.
  1. Finding Games
  • Users can find the games from the games section on the top bar and can filter them by, selecting filters and then clicking filter button.

Screenshot_20231229_142158

  1. Getting Info About Games
  • The detail page can be viewed by clicking on the details button from the games page.

Screenshot_20231229_142227

Comment
  • When user visits the post detail page, he/she will see comments related to that post.

  • When user clicks "Comments" button in the post detail page, he/she can write a comment.

  • When user clicks pencil icon in the comment, he/she can edit the comment.

  • When user clicks trash can icon in the comment, he/she can delete the comment.

  • When user clicks message bubble icon in the comment, he/she can reply to the comment.

Profile
  • When user clicks the "Profile" tab in the top bar, he/she can see his/her profile. In profile page he/she can see his/her achievements

  • When user clicks the "Edit Profile" button in the profile page, he/she can edit his/her profile.

  • When user clicks the "Last Activities" button in the profile page, he/she can see last activities including posts, comments, reviews, votes.

Review
  • In order to create reviews, a user should log in first. Then the user should go to the game information page (see the games section). Then user should select the reviews section. There the other reviews can also be seen. In order to create a new review, the user should write his/her opinions in the left-upper most text box and should select a star (0.5 to 5) and lastly, user should finalize the process by clicking on the tick button.

Screenshot_20231229_143026

Forum
  • Every game and group has a section where users can create posts and interact with each other and each other's posts by commenting and voting functionalities.

  • An example of a forum of a game called Fallout: New Vegas can be observed below

  • An example of a forum of a group called Persone 4 Golden Fans can be observed below

Annotation
  • An image annotation can be created by admin by holding left click and dragging mouse across the image. While drawing a rectangle will appear and after the mouse button is released, a box to type text will appear. After typing the annotation there and clicking OK, the annotation will be created.

Screenshot_20231229_202610

  • A textual annotation can be created by an admin on game and post descriptions. Also users can create textual annotations on their own posts. In order to create them, the user should simple drag their mouse on text while holding the mouse button. And after releasing the button a text box will appear. After adding text and clicking Ok the annotation will be created.

Screenshot_20231229_202421

  • By clicking the annotation area, users can see the annotated text. The annotation can be edited and removed from there (by admins or creators of annotation). Also a reply to annotation can be added in the text box below.

Screenshot_20231229_202626

  • An example of a forum of a game called Fallout: New Vegas can be observed below

  • An example of a forum of a group called Persone 4 Golden Fans can be observed below

Admin Functionality
  • Platform admins can see the "Admin" tab in the top bar. By clicking it, admins will be redirected to the Admin main page. In this page, there are functions that only admins are allowed to perform.
image
  • Using the "Create Tag" page, admins can create tags in the platform.
image
  • Using the "Update Tag" page, admins can update a tag.
image
  • Using the "Delete Tag" page, admins can delete a tag.
image
  • Using the "Ban User" page, admins can ban a user.
image
  • Using the "Give Admin Permission" page, admins can change a user's role to admin.
image
  • Using the "Create Achievement" page, admins can create an achievement within the platform.
image
  • Using the "Delete Achievement" page, admins can delete an achievement.
image
  • Using the "Add Character" page, admins can add characters to the platform.
image


💻 Meeting Notes

Cmpe 352
Cmpe 451

📝 Requirements


🪧 Diagrams


📬 Deliverables

Cmpe 352
Cmpe 451

🎇 General Contributions

Cmpe 352 Contributions

Milestone 1
Final Milestone

Cmpe 451 Contributions

Milestone 1
Milestone 2
Final Milestone

📕 Mock Up


🕵️ User Scenario



📝 RAM


📚 Research


📑 Templates


📱 Practice App

API Documentation for Practice App
Clone this wiki locally