Code Monkey home page Code Monkey logo

dungeon-crawler's Introduction

Dungeon Crawler

A Fate- and Diablo-style dungeon crawler game, made with Unity, using C#. Made as part of OTMK18.

Releases

Most recent release: v1.0.0

Documentation

Files

.md-files are in Finnish, but i.e. the diagrams in the architecture file are in English.

Määrittelydokumentti (Specification document)

Tuntikirjanpito (Time tracking)

Arkkitehtuurikuvaus (Architecture / diagrams)

Käyttöohje (Install instructions / how to play)

HTML docs from XML-tags

Easy way

The ready-generated HTML-files are as a package in the Documentation folder. Clone the repo, unpack the file (HTML-documentation.tar.gz), open the html-folder and open the index.html-file with some browser.

Generating by hand

You can probably get this done with something like Visual Studio as well. However, Doxygen offers an easy way to do it and it works on Win, Mac and Linux:

Install Doxygen (simple installation for Linux here), navigate to root of project, run command 'doxygen dungeon-crawler.conf', navigate to the generated html folder, run 'firefox index.html' (or use your favourite web browser).

Running tests and checks and such

Testing

Unit tests are located in the Assets/Editor folder. In order to run them, open the project in Unity, open the Test Runner (Window - Test Runner), select EditMode and double-click on a test, file, or folder.

Code analysis

I use ReSharper for code analysis. In order to run the analysis, open the project in Unity, select Assets - Open C# Project, open the generated .sln file with an IDE with ReSharper (I use JetBrains Rider), and run code analysis (In Rider, Code - Inspect code). My ReSharper settings are still default.

dungeon-crawler's People

Contributors

sofvanh avatar

Watchers

Alexander Truong avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.