Edna ·

Edna is a starter kit for creating point-and-click adventure type games with Unity.

Status

• Too early to use
• Work in Progress
• The API can and will change with each new commit
• Folder structure and Asset names can and will change

Features (So Far)

• Localization: Supports the ability to localize your game in multiple languages. The game will use the system default language if supported, a user chosen language or game default language. Translations can be managed in a spreadsheet and imported as a tab delimited file using the provided StringImporter.
• Audio Mixer: The audio mixer contains 3 channels: Music, Effects and Speech with independant volume controls and a master volume control. User's settings are automatically recorded to disk and restored on launch.
• Menu Template: A basic menu system is provided that has 3 screens.
  • Main Menu: Continue Game, Start New Game, Load Game, Settings, Quit
  • Load Game: Main Menu, Save New Game, Load Existing Game
  • Settings: Sound Settings, Graphics Settings, Game Settings
• Dialogue System Very much a work in progress. Right now working through Unity's GridView and building out a visual way to manage conversations between characters.
• Edna Demo: A demonstration of a pont-n-click adventure game built using Edna. While the demo is small, it showcases every feature available.

Installation

For now this project is set up as a starter Unity Project that you would open in Unity 2019.3.15f1 or later. Older versions of 2019.3 might work but are not support.

I will eventually use Unity's package importing feature at some point and put it into the Unity Asset Store. But right now it's too early in development.

Documentation

To be written.

Contributing

The main purpose of this repository is to continue to evolve Edna, making it faster and easier to use. Development of Edna will happen in the open on GitHub, and I am open to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Edna.

Code of Conduct

I have adopted a Code of Conduct that I expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Here are some ways you can help me with this project:

• Reporting Bugs
• Suggest Enhancements
• Look through help-wanted issues and submit a pull request

C# Coding Conventions

C# Coding conventions serve the following purposes:

• They create a consistent look to the code, so that readers can focus on content, not layout.
• They enable readers to understand the code more quickly by making assumptions based on previous experience.
• They facilitate copying, changing, and maintaining the code.
• They demonstrate C# best practices.

Edna follows Microsft's C# Coding Conventions. Following these conventions are a requirement for code submissions.

License

Edna is MIT licensed.