A bit more work on the user guide; Misc changes
This commit is contained in:
parent
9101000b97
commit
f66c3fb4e0
BIN
docs/images/blankproject.png
Normal file
BIN
docs/images/blankproject.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 70 KiB |
@ -13,16 +13,53 @@ In order to develop an NF application, you must first have the following:
|
||||
- Apt C++ knowledge
|
||||
- The engine itself
|
||||
|
||||
The current version of the engine can be downloaded [here](http://mrgrapedave.com/nf/nf.zip).
|
||||
The current version of the engine can be downloaded [here](http://graysonriffe.com/nf/nf.zip).
|
||||
|
||||
---
|
||||
|
||||
@section projSetup Step One: Template Setup
|
||||
@note Windows Security may first need to scan some of the included binaries and your
|
||||
build output before they can be run. You should never get a message from Windows Security
|
||||
that a virus has been found in any of these files.
|
||||
|
||||
Inside the zip file, you will find:
|
||||
|
||||
- **example** - The example app complete with the source and a build
|
||||
- **manual** - An offline version of this manual
|
||||
- **index.html** - The homepage
|
||||
- **template** - A template MSVC project with options already setup to work well with the engine
|
||||
- **redist** - MSVC Redistributable (See @ref packaging)
|
||||
- **template** - A template MSVC project already setup to work with the engine
|
||||
|
||||
---
|
||||
|
||||
@section projSetup Template Setup
|
||||
|
||||
In the `template` folder, you will find:
|
||||
|
||||
- **assets** - Contains assets (See @ref assets)
|
||||
- **bin** - Output directory for both configurations
|
||||
- **dep** - Contains the engine
|
||||
- **src** - The source folder with a `main.cpp` file
|
||||
- **template.sln** - The Visual Studio solution
|
||||
|
||||
`template.sln` can be opened in Visual Studio 2022. This, as well as the name of the
|
||||
project (`NFApp` by default), can be renamed at any time.
|
||||
|
||||
@note The template project is setup to build *Debug* and *Release* configurations. The *Debug*
|
||||
configuration includes a console window with debug output. The *Release* configuration does
|
||||
not have this console window. By default, the current configuration can be changed in the
|
||||
top toolbar.
|
||||
|
||||
Once the solution has been opened, you can find the `main.cpp` file inside the `src` folder
|
||||
as shown below.
|
||||
|
||||
@image html blankproject.png "The template opened in Visual Studio" width=70%
|
||||
|
||||
To build the project, go to Build -> Build Solution or Build Project. Both do the same thing
|
||||
since there's only one project in the solution initially. You could also hit the default
|
||||
keyboard shortcut of `Ctrl-Shift-B`.
|
||||
|
||||
@note After your application is built, your assets are also built and placed into
|
||||
the output `assets` directory. As your project grows, this could take longer and longer,
|
||||
so this can be disabled in the project properties dialog under Build Events -> Post-Build Event.
|
||||
Change "Use In Build" to "No" and save.
|
||||
|
||||
NF is a **statically-linked** library. This means that your build will not
|
||||
rely on any external dlls other than the MSVC redistributable.
|
@ -3,8 +3,12 @@
|
||||
|
||||
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.
|
||||
First, follow the steps on the @ref install page. Once the template MSVC project is setup,
|
||||
you can begin here.
|
||||
|
||||
@section nfArch NF Engine Architecture
|
||||
|
||||
|
||||
|
||||
@section createConfig Creating a Config
|
||||
|
||||
@ -16,6 +20,4 @@ MSVC project in Visual Studio, you can begin here.
|
||||
|
||||
@todo Lighting page?
|
||||
|
||||
@image html logofull.png "NF Logo" width=200px
|
||||
|
||||
Really cool
|
||||
@section packaging Packaging Your Game
|
@ -1,4 +1,5 @@
|
||||
@page assets Asset System
|
||||
@tableofcontents
|
||||
|
||||
This page details NF's asset system and custom pack format.
|
||||
|
||||
|
@ -5,7 +5,7 @@ for Windows. It was created by Grayson Riffe in 2021. This manual aims to aid th
|
||||
with using this engine to create games and visualizations. It contains the
|
||||
[user guide](tutorial.html) and the [API reference](namespaces.html).
|
||||
|
||||
@image html logofull.png "Engine Logo" width=200px
|
||||
@image html logofull.png "Engine Logo" width=15%
|
||||
|
||||
Features
|
||||
===
|
||||
@ -30,6 +30,5 @@ at any time.
|
||||
Example App
|
||||
===
|
||||
|
||||
You can download the source or build for the example game that includes all of the
|
||||
aforementioned features.
|
||||
@todo Example App download
|
||||
In the engine download, the example app's source and a build is included in the `example`
|
||||
folder.
|
@ -1,3 +1,23 @@
|
||||
.image
|
||||
{
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
img:not([src='logofull.png']):not([src="search/mag_sel.svg"]):not([src="doxygen.svg"]):not([src="logo.png"])
|
||||
{
|
||||
box-shadow: 0.5em 0.5em 0.5em grey;
|
||||
}
|
||||
|
||||
div.caption
|
||||
{
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
#nav-sync
|
||||
{
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
/* The standard CSS for doxygen 1.9.2 */
|
||||
|
||||
body, table, div, p, dl {
|
||||
@ -1402,11 +1422,6 @@ dl.section dd {
|
||||
border-bottom: 1px solid #B48453;
|
||||
}
|
||||
|
||||
.image
|
||||
{
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.dotgraph
|
||||
{
|
||||
text-align: center;
|
||||
|
Reference in New Issue
Block a user