Skip to content

User Manual

Jump to bottom
Ondřej Čopák edited this page May 7, 2025 · 1 revision

🐑 Sweet Fluffy Sheep - User Manual

📽️ Game Trailer

Trailer of Sweet Fluffy Sheep

📦 Requirements

  • Java 21.0
  • All dependencies listed in pom.xml
  • Processor
  • Mouse / Touchpad

⚙️ Setup

  1. Clone the repository

    git clone https://gitlab.fel.cvut.cz/B242_B0B36PJV/copakond.git

  2. Navigate to the project directory, install dependencies, build the project, and run:

    src\main\java\cz\cvut\copakond\sweetfluffysheep\Launcher.java

  3. Enable logging (optional) Run with the -logger flag:

    Launcher.java -logger

    This prints log messages to stdout / stderr. More details available in module-info.java and logger classes.

🎮 How to Play

🧑‍🌾 First Time

Upon launching the game for the first time, you will be redirected to the profile creation screen. You must:

  • Enter your profile name (1)
  • Confirm it (2)

Once created, click Back (5) to return to the main menu.

👤 Profile Management

  • To switch profiles, select one from the list (4)
  • The active profile will be highlighted in green (3)
  • The selected profile name appears in the main menu

manual_1

🏠 Main Menu

Here’s what you can do from the main menu:

  1. Play a level → Goes to level selection (1)
  2. Continue → Starts the first uncompleted level (2)
  3. Edit → Opens the level editor selection (3)
  4. Switch profiles (4)
  5. Settings → Opens settings menu (5)
  6. Exit → Closes the game (6)

manual_2

📜 Level Selection

Here you can select which level to play:

  • Green = completed levels (1)
  • Gray = uncompleted levels (2)
  • Upper section = story levels (1,2)
  • Lower section = user-created levels (3)
  • Return to main menu (4)

manual_3

🛠️ Level Editor Selection

Similar to level selection, but for editing:

  • Select a level to edit (1)
  • Create a new level with the "+" button (2)
  • Return to main menu (3)

manual_4

⚙️ Settings

Available from the Menu, Level, and Level Editor screens.

Adjustable settings:

  1. Music Volume (0–100%) (1)

  2. Sound Effects Volume (0–100%) (2)

  3. FPS (1–240) (3)

    • Default: 60
    • Affects animation smoothness
    • Too high may cause lag
    • Game restarts on FPS change

  4. Fullscreen Mode (4)

    • Toggle with F11 or here
    • F11 toggle is not saved

  5. Confirm changes with (5)

Settings are saved automatically for future sessions.

manual_5

🕹️ Gameplay + Controls

You play as a 2D sheep navigating a level using arrows (7) to control direction. The objective is to reach the goal (4), but it remains locked until all coins (3) are collected. Beware of enemy wolves (2) and the ticking timer...

↪️ Arrows (7)

Control everything using your mouse:

  • Left click (empty tile) → Place arrow
  • Left click (arrow) → Rotate arrow
  • Right click (arrow) → Remove arrow

⚠️ You have a limited number of arrows. You must remove existing ones to place more.

Arrows change the direction of both sheep and enemies. They’re ignored if pointing at walls and can only be placed on valid tiles.

🐑 Sheep (1)

  • Start in a line, spaced 1 tile apart

  • Move straight until:

    • Hitting a wall
    • Hitting an arrow
    • Hitting an enemy = death

  • Collects coins and items

  • Becomes immortal once reaching the goal

Slowing will occur if multiple sheep occupy the same tile.

You must save a specific number of sheep (shown in the HUD). The level ends when:

  • All sheep are gone
  • Timer runs out

If you saves the required amount of sheep, you will win, even if the time runs out.

🐺 Enemies (2)

  • Wolves move like sheep
  • Do not collect coins or items
  • Do not enter the goal
  • Can kill sheep — guide them carefully!

🪙 Items (3, 5, 6)

  1. Coin (3)

    • Required to unlock the goal

  2. Freeze (5)

    • Freezes enemies for a set duration
    • Sheep can walk through them
    • Default: 10 seconds

  3. Rage (6)

    • Lets sheep kill enemies
    • Duration varies
    • Default: 10 seconds

manual_7

📊 HUD Overview

Located at the bottom of the screen:

  1. Speed Multiplier (1)

    • 1x, 2x, 4x
    • Affects movement/animation
    • Timer not affected

  2. Coins (2)

    • Collected / Total
    • Unlock goal when equal

  3. Active Sheep (3)

    • Alive and not at goal

  4. Arrows (4)

    • Placed / Max allowed

  5. Time Left (5)

    • In seconds

  6. Pause (6)

  7. Retry (7)

  8. Settings (8)

  9. Menu (9)

    • ⚠️ Does not save progress!

manual_6

✅ Win Screen

These stats will be shown:

  • Time spent
  • Coins collected
  • Sheep saved
  • Enemies defeated
  • Total score displayed

Options:

  • Continue → Next level
  • Menu → Return to main menu

manual_8

❌ Lose Screen

If you lose:

  • Shows the reason

  • Options:

    • Retry
    • Return to Menu

manual_9

🧱 Level Editor

Create and customize your own levels!

  • Place, rotate, and remove objects
  • Change level variables
  • Playtest your design
  • Saved levels appear in level selection

✏️ Editing a Level

Options available via the HUD:

  1. Add Tile (1)
  2. Remove Tile (2)
  3. Add Wolf (3)
  4. Add Coin (4)
  5. Add Freeze (5)
  6. Add Rage (6)
  7. Add Start (7)
  8. Add Goal (8)
  9. Rotate Object (9)
  10. Remove Object (10)

Additional options:

  • Playtest Level (11)
  • Change Variables (12)
  • Settings (13)
  • Return to Menu (14)

manual_10

⚙️ Changing Variables

Click "Change Variables" (12) to edit:

  1. Time Limit (1)

    • Default: 180 seconds

  2. Number of Sheep (2)

  3. Goal Sheep (3)

    • Must be ≤ total sheep

  4. Max Arrows (4)

    • Must be ≤ map size

  5. Map Size (Width x Height) (5,6)

    • Default: 24x12, because the aspect ration of tiles is then ~1:1
    • To shrink map, no objects can be in the removed area.

  6. Item Duration (7)

    • Freeze / Rage
    • Affects new items only
    • To apply to old items, you need to delete them and place them again
    • In seconds
  • Click Save (8) to confirm
  • Click Cancel (9) to discard

manual_11

📢 Publishing Your Level

To make a level playable:

  1. Must have a start and a goal

  2. Must contain at least one coin

  3. Pathfinding must:

    • Reach the goal
    • Collect all coins

  4. Playtest it (11)

  5. After successful completion, level is saved and published

🔁 You can edit the level anytime as long as these conditions are met.

🎉 Final Words

That’s it! You’re ready to play and create. If you have any questions, visit our GitLab page.

Good luck! Save the sheep. Dodge the wolves. Collect the coins. Beat the high score. AND HAVE FUN!

Ondřej Čopák, ProfiPoint 2025

Clone this wiki locally