Welcome to Avarice

Welcome to the one-stop shop for documentation on Avarice.

What is Avarice?

Avarice was/is developed by Ouroboros Creations, which was founded by a small group of seniors at Champlain College. It is a four-player online or local couch competitive game,in which players compete to collect as much as they can. To collect (points), they must find Greed to become the embodiment of Greed and destroy the world around them. If someone else is already embodying Greed, the three other players must work together to take them down.

Using the docs

You can use these docs as a guide to develop content for the game. A good place to start is Project Setup.

Table of Contents

• General
  • Art Pipeline
• Unreal Engine 4
  • Project Setup
    • Install Unreal Engine 4
    • Install Visual Studio 2017
    • Install SourceTree
    • Clone the repository
    • Generate Project Files
    • Build Binaries
    • Start Creating
• Content
  • Client Owner
  • Server
    • BpGameMode
      • Description
    • SrcGameMode
      • Description
  • Server and Client Owner
  • Server and Clients
    • Entity
      • Player
        • BpPlayerCharacter
• Tutorials
  • Tutorial: Stage Act
    • Make the subclass
    • Changing stats
  • Tutorial: Player Action
  • Tutorial: Destructible
  • Tutorial: Level
• Builds
  • Checklist
  • Make a Build
    • Version Bump
    • QA Build Repo
    • Packaging
    • Tag the commit
    • Push & Upload
  • QA
    • Finding the repo
    • Pull our build
    • Prepping the Survey
    • Launcher
    • Pushing your configuration
    • Setting up other computers
    • Ready to Test!!
• Documentation
  • Building the Documentation
    • How are docs built?
    • Can I view my changes without pushing?
    • Tell me how to publish my stuff for others!!
  • Creating a doc

Backlog of docs to write

• overview of the gameplay loop

• Making a level

  • player spawns & tags
  • greed gem spawns & tags

• how does networking work?
• YOGURT & using it
• main menu flow
• pause menu flow
• flow of other menus & how they work
• ui: keybindings menu (control mapping)
• ui: analytics opt-in system