Examples for Your Reference

There are several examples of text-based games available for your reference. You should not copy any code from the Internet directly.

Caveat: Plagiarism is strictly prohibited. Please ensure that all your project submissions are plagiarism-free, or you risk losing all marks in the project. Please refer to "What is plagiarism?" - HKU T&L for the definition and scope of plagiarism.

Requirements

• Code Requirement. Your implementation should include all the following coding elements:

o Generation of random game sets or events

o Data structures for storing game status (e.g., arrays, STL containers)

o Dynamic memory management (e.g., dynamic arrays, linked lists, STL containers)

o File input/output (e.g., for loading/saving game status)

o Program codes in multiple files (recall separate compilation)

o Proper indentation and naming styles

o In-code documentation

•   All project files should be committed to a private GitHub repo.

• Contributions: Each  student  should  contribute  certain  added   (+)  lines  of  the  code  and documents to their project, gauged by GitHub’s “Contributors Graph” .

o For a group of 2, each student should contribute at least 25%.

o For a group of 3, each student should contribute at least 20%.

o For a group of 4 - 5, each student should contribute at least 10%.

o If you cannot meet the contribution percentage and fail to provide reasonable excuses in the self-evaluation, you will receive no mark for the project.

•   Commit comments should not be empty and should be written sensibly.

•    For each function, comments on “what it does”, “what the inputs are”, and “what the outputs are” are needed.

•   You may use any C/C++ libraries that don't require any additional installation on the grader's side. That means the grader won't download any libraries from the internet for you, and your program will be considered not compliable because of missing dependencies. To use a library that requires additional installation, you should either put the necessary files from a library together with your code so that an additional installation is not needed, or you shouldn't use the library at all.

•   You should make sure your code can be successfully compiled in the Computer Science Department's “academy” server.

Stage 1: Grouping

The purpose of this milestone is to help you define the project scope and consolidate your ideas before you start to implement.

What to do for this milestone:

•   To form a project group and indicate your group members as mentioned in the previous section.

•   To identify a text-based game type that you would like to implement. Or design your own game.

•   To decide what features your text-based game would have.

•   To set up a private GitHub repo where your work will be hosted.

What to do (by each group)

•   Set up a private Github repo that includes all group members and the teaching team account

engg1340comp2113.

•   You can refer to Inviting collaborators to a personal repositoryGitHub Docs for the procedure to add collaborators.

•   The teaching team will accept the invitation within 7 days. If we fail to do so, please add again.

Reference:

• Getting started with writing and formatting on GitHub;

• About READMEs

Stage 2: Project Submission

What to do for this milestone:

•   To implement the text-based game.

•   To document your code.

What to submit (by each group)

•    In the same Github repo that you set up in Stage 1.

o Create a README.MD file in the repo that contains:

. Identification of the team members.

. A description of your game and introduce the game rules.

. A list of features that you have implemented and explain how each coding element 1 to 5 listed under the coding requirements aforementioned support your features.

. A list of non-standard C/C++ libraries, if any, that are used in your work and integrated to your code repo. Please also indicate what features in your game are supported by these libraries.

. Compilation and execution instructions. This serves like a "Quick start" of your game. The teaching team will follow your instructions to compile and run your game.

o Your code including the makefile and all source files (.h / .cpp / .c)

•   Submit a link to the repo to Moodle. (Refer to the details on the submission page)

•   A video (at most 3 minutes long) demonstrating a gameplay and the implemented features of your program.