Started writing a manual; Lots of changes
This commit is contained in:
1 parent
f884847513
commit
3b5b608ae9
53 files changed
+3851
-241
No files matched your search
@@ -0,0 +1,19 @@
|
||||
@page install Installation
|
||||
@tableofcontents
|
||||
|
||||
This page details how to install NF in a MSVC project.
|
||||
|
||||
@section prereq Prerequisites
|
||||
|
||||
In order to create an NF application, you must first have the following:
|
||||
|
||||
- Visual Studio 2022 or later (MSVC v143 or later)
|
||||
- A 64 bit computer as NF is 64 bit only
|
||||
- A compatible graphics card (See @ref issues)
|
||||
- Apt C++ knowledge
|
||||
- The engine itself
|
||||
@todo Link download here?
|
||||
|
||||
@section projSetup Step One: Project Setup
|
||||
|
||||
@note kdlsjfldksjf
|
||||
@@ -0,0 +1,21 @@
|
||||
@page tutorial Tutorial
|
||||
@tableofcontents
|
||||
|
||||
This tutorial aims to teach the basics of the engine and how to use it.
|
||||
|
||||
First, follow the steps on the @ref install page. Once NF has been installed into a new
|
||||
MSVC project in Visual Studio, you can begin here.
|
||||
|
||||
@section createConfig Creating a Config
|
||||
|
||||
@todo The tutorial page
|
||||
|
||||
@section createUI Creating a UI
|
||||
|
||||
@section createCubemap Adding a Cubemap (Skybox)
|
||||
|
||||
@todo Lighting page?
|
||||
|
||||
@image html logofull.png "NF Logo" width=200px
|
||||
|
||||
Really cool
|
||||
@@ -0,0 +1,8 @@
|
||||
@page gamestates Gamestate System
|
||||
@tableofcontents
|
||||
|
||||
@todo The gamestates page
|
||||
|
||||
@section enterAndExit onEnter and onExit
|
||||
|
||||
@section obLifetime Object Lifetime
|
||||
@@ -0,0 +1,13 @@
|
||||
@page assets Asset System
|
||||
|
||||
This page details NF's asset system and custom pack format.
|
||||
|
||||
@section buildAssets How to Build Your Assets
|
||||
|
||||
@todo Asset system page
|
||||
|
||||
@section customFonts Custom Font Assets
|
||||
|
||||
@section customButtons Custom Button Assets
|
||||
|
||||
@section customCubemap Custom Cubemap Assets
|
||||
@@ -0,0 +1,6 @@
|
||||
@page issues Known Issues
|
||||
|
||||
This page includes the known issues of the engine in order of importance.
|
||||
|
||||
1. Shader compilation errors
|
||||
- This issue is caused by differences in graphics drivers and what exact OpenGL shader code they will compile. **This issue will be attended to soon.**
|
||||
@@ -0,0 +1,35 @@
|
||||
@tableofcontents
|
||||
|
||||
Nothin' Fancy (abbreviated as NF) is an experimental 3D game engine written in C++
|
||||
for Windows. It was created by Grayson Riffe in 2021. This manual aims to aid the end-user
|
||||
with using this engine to create games and visualizations. It contains a user guide and
|
||||
the API reference.
|
||||
|
||||
@image html logofull.png "Engine Logo" width=200px
|
||||
|
||||
Features
|
||||
===
|
||||
|
||||
In its current form, NF is always changing and evolving, so some of these features could change
|
||||
at any time.
|
||||
|
||||
- @ref gamestates
|
||||
- @ref assets
|
||||
- Easy-to-use input
|
||||
- Deffered renderer
|
||||
- Materials system
|
||||
- Color, specular, and normal texture support
|
||||
- Cubemap support
|
||||
- 3D sound support
|
||||
- Rigid body physics
|
||||
- Customizable UI
|
||||
- Text
|
||||
- Textures
|
||||
- Buttons also with customizable textures
|
||||
|
||||
Example App
|
||||
===
|
||||
|
||||
You can download the source or build for the example game that includes all of the
|
||||
aforementioned features.
|
||||
@todo Example App download
|
||||
Reference in new issue
Block a user