-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the README to fit the other repo
- Loading branch information
1 parent
293ebbe
commit 231e896
Showing
1 changed file
with
21 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,42 @@ | ||
| # Java Fighting Game: NTNU FIGHTERZ Project | ||
| # JavaFX Fighting Game: NTNU FIGHTERZ | ||
| ## Group 1 IT1901 Fall 2022 course | ||
|
|
||
| [](https://gitpod.stud.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/groups-2022/gr2201/gr2201.git) | ||
|
|
||
| ### _Made by: Sverre Nystad, Elin Haugum, Kristoffer Olaisen and Simon Sandvik Lee_ | ||
| --- | ||
| [](https://www.youtube.com/watch?v=3NE40v7QaqM) | ||
|
|
||
| ### Hvordan åpne prosjektet | ||
|
|
||
| Prosjektet vårt kan åpnes ved å skrive inn: | ||
| _Click on the GIF to watch the full game with sound._ | ||
|
|
||
| `mvn javafx:run` i terminalen din. | ||
|
|
||
| --- | ||
| ### About | ||
|
|
||
| NTNU FIGHTERZ is a scaling fighting game similar to Super Smash bros. It only has one playable character in its current version; _"The Angry Cyclist"_. | ||
|
|
||
| ### Hvordan kjøre Jacoco og få rapporten | ||
| _Our Project is seperated into four main parts: **base**, **docs**, **fxui** og **gameplay**_ | ||
|
|
||
| Jacoco kan åpnes ved å skrive inn: | ||
| **Base** contains userinformation. DAO; Database Access Object is used. [Base README](gr2201/base/readme.md) | ||
|
|
||
| `mvn clean jacoco:prepare-agent install jacoco:report` i terminalen din. | ||
| **Docs** and the folder **release1** contains all the documentation for the project. Here lies all from diagrams to meetings. [Docs README](gr2201/docs/readme.md) | ||
|
|
||
| **Fxui** contains most of the graphical and "main" parts of the project. [Fxui README](gr2201/fxui/readme.md) | ||
|
|
||
| **Gameplay** contains all the game logic. [Gameplay README](gr2201/gameplay/readme.md) | ||
|
|
||
| --- | ||
|
|
||
| ### Om prosjektet | ||
| ### How to open the project | ||
|
|
||
| _Prosjektet vårt er delt opp i tre hovedmapper i mappen gr2201. | ||
| Her har vi **base**, **docs**, **fxui** og **gameplay**._ | ||
| Our project can be launched by typing: | ||
|
|
||
| **Base** inneholder alt som omhandler brukerinformasjon. Det er kode som feks. DAO, hvor Database Access Object partern blir fulgt. [Base README](gr2201/base/readme.md) | ||
| `mvn javafx:run` in your terminal. | ||
|
|
||
| --- | ||
|
|
||
| **Docs** og undermappen **release1** inneholder all dokumentasjon om prosjektet fram til nå. Her ligger alt fra diagrammer, figma og møtereferat. [Docs README](gr2201/docs/readme.md) | ||
| ### How to run Jacoco and get the report | ||
|
|
||
| **Fxui** inneholder hovedkoden vår, alle fxml filer, bilder, og kontrollere. Her er det mesteparten av _kodingsprosjektet_. [Fxui README](gr2201/fxui/readme.md) | ||
| Jacoco can be launched by typing: | ||
|
|
||
| **Gameplay** har alt som har med spillogikken å gjøre. Her er alle klassene som får hovedspillet til å kunne kjøre. [Gameplay README](gr2201/gameplay/readme.md) | ||
| `mvn clean jacoco:prepare-agent install jacoco:report` in your terminal. | ||
|
|
||
| --- | ||
|
|
||
|
|