Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 3.34 KB

README.md

File metadata and controls

79 lines (63 loc) · 3.34 KB
Raw

Software Engineering 2019/2020 - Final project

Build Release

Team: Julia Cichosz, Klaudia Goska, Marek Grzelak, Hubert Jaremko, Anna Misiewicz, Łukasz Sereda

Project description

Cute Animals is a dark fantasy single-user dungeon RPG made as a semester project for the Software Engineering course at Jagiellonian University
The game is available at https://io-rpg.herokuapp.com/.

Gameplay

The game is using a text-user-interface inspired by the Single-User Dungeon genre (ex. Otchłań (pol)). The player interacts with the world by typing in proper commands such as go, investigate or pick. Full list of available commands is in the Documentation section.

The game flow is as follows:

  1. First, the player picks his character's class.
  2. Every class offers unique abilities.
  3. The player goes through successive locations, where he has the opportunity to explore, interact with other characters (e.g. conversation, fight), and collect items.
  4. At each stage of the game, there are different possible courses of the game.
  5. The collected items can be used in the further course of the game (depending on the item: for combat, defense, or to increase a given attribute)
  6. As the player overcomes successive obstacles, the player will gain experience and develop individual attributes.

Screenshots

Used technologies

  • Server
    • Java 11
    • Spring MVC
    • PostgreSQL
    • Heroku
  • Client
    • xterm.js
  • Tests
    • JUnit 5
    • Mockito
    • AssertJ

Building

./gradlew build -x test

Required environment variables

SPRING_DATASOURCE_URL : jdbc:postgresql://localhost:5432/<database name>
SPRING_DATASOURCE_USERNAME : postgres
SPRING_DATASOURCE_PASSWORD : your password
SPRING_PROFILES_ACTIVE : dev or prod

Documentation

Full documentation, test and coverage reports, binary files are in artifacts.

UML diagrams are here.

Avaiable commands

  • start - starts the game
  • investigate - provides a description of the current location
  • talk <character_name> - allows you to talk to individual characters
  • go <location_name> - allows you to go to another location
  • pick <item_name> - allows you to pick up an item and put it in your backpack
  • throw <item_name> - allows you to discard an item out of the backpack
  • equip <item_name> - allows you to put on an item from a backpack
  • off <item_name>- allows you to unequip an item and put it in the backpack
  • backpack - lists the current state of the backpack
  • eq - lists the currently equipped items
  • stats - lists the character's statistics
  • skills - lists the character's abilities
  • fight <character_name> - allows you to fight individual characters
  • attack - allows you to attack in combat mode
  • block - reduces damage in the next two turns in combat mode
  • use <item_name> - allows you to use an item
  • cast <skill_name> - allows the use of a given skill in combat mode
  • suicide - allows you to reset the game to its initial state