Skip to content

Commit

Permalink
Update ReadMe.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanedds authored Sep 1, 2016
1 parent 45e4fb1 commit 20aedec
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
Nu Game Engine [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bryanedds/NuGameEngine/blob/master/LICENSE.md)
Nu Game Engine [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bryanedds/Nu/blob/master/License.md)
=

What is the **Nu Game Engine**?

*"The Nu Game Engine is a game development platform that aims to drastically reduce the cost of game development by providing a superior programming model for games via Iterative Functional Reactive Programming (IFRP). After finally reaching v1.3.0.4, the implementation has matured enough to prove both the efficacy and viability of pure functional programming in games in terms of performance, programmability, and reliability."*

![Screenshot](InfinityRpg/Promotional/InfinityRpg.png?raw=true)
![Screenshot](Projects/InfinityRpg/Promotional/InfinityRpg.png?raw=true)

This repository hosts several projects, including -

- ![Alt text](Nu/Promotional/Nu Icon.png?raw=true "Nu Game Engine"), the **Nu Game Engine**, a cross-platform F# 2D game engine built in the functional style. Uses SDL2 and Farseer Physics.
- ![Nu Icon](Nu/Nu.Promotional/Nu Icon.png?raw=true "Nu Game Engine"), the **Nu Game Engine**, a cross-platform F# 2D game engine built in the functional style. Uses SDL2 and Farseer Physics.
- the sample game **BlazeVector**.
- the work-in-progress game **InfinityRpg**.

Here's an article explaining why functional programming works for games, and what motivated me to create this game engine - https://medium.com/@bryanedds/functional-game-programming-can-work-95ed0df14f77

And here is some media on the Nu Game Engine -

![Screenshot](BlazeVector/Promotional/BlastingAwayInBlazeVector.png?raw=true)
![Screenshot](Projects/BlazeVector/Promotional/BlastingAwayInBlazeVector.png?raw=true)
Nu's tutorial game, BlazeVector!

![Screenshot](BlazeVector/Promotional/EditingASectionOfABlazeVectorStage.png?raw=true)
![Screenshot](Projects/BlazeVector/Promotional/EditingASectionOfABlazeVectorStage.png?raw=true)
Editing a section of a BlazeVector stage.

![Screenshot](Nu/Promotional/Nu Special Effects.png?raw=true)
![Screenshot](Nu/Nu.Promotional/Nu Special Effects.png?raw=true)
Editing a special effect in Nu.

Getting Started
===============

The best way to get started is to pull down the repository with a git client, and to take a look at the following documents -

The current documentation for the **Nu Game Engine** is found here - https://github.com/bryanedds/FPWorks/blob/master/Nu/Documentation/Nu%20Game%20Engine.pdf?raw=true
The current documentation for the **Nu Game Engine** is found here - https://github.com/bryanedds/FPWorks/blob/master/Nu/Nu.Documentation/Nu%20Game%20Engine.pdf?raw=true

There is additional documentation on **advanced Nu game programming techniques** in an 'experience report' found here -
https://github.com/bryanedds/NuGameEngine/blob/master/Nu/Documentation/Iterative%20Functional%20Reactive%20Programming%20with%20the%20Nu%20Game%20Engine.pdf?raw=true
https://github.com/bryanedds/Nu/blob/master/Nu/Nu.Documentation/Iterative%20Functional%20Reactive%20Programming%20with%20the%20Nu%20Game%20Engine.pdf?raw=true

Finally, please check out the license for this repository below!

Expand All @@ -45,11 +45,6 @@ Sponsors

The **Nu Game Engine** is looking for sponsors! If you're interested in sponsoring development for what I hope will become **the world's first mainstream functional game engine**, please contact me at bryanedds@gmail.com . Otherwise, I'll just have to work on it in my spare time, which can be erratic :S

Project Vlog
============

Keep up with the state of development and get some insight on how the projects are implemented here - https://www.youtube.com/channel/UCPoDCc41MwqEwhIHp32LpSA

Code of Conduct
===============

Expand Down

0 comments on commit 20aedec

Please sign in to comment.