noggit3

LICENSE

This software is open source software licensed under GPL3, as found in the COPYING file.

DISCORD

You can follow Noggit's development and get the latest build here: https://discord.com/invite/UbdFHyM

SCRIPTING

Noggit can be scripted using the Lua (5.1) programming language. See the scripting documentation.

BUILDING

This project requires CMake to be built. It also requires the following libraries:

• OpenGL
• Qt 5

Further following libraries are required for MySQL GUID Storage builds:

• LibMySQL
• MySQLCPPConn

The following libraries are automatically installed:

• StormLib (by Ladislav Zezula)
• FastNoise2 (scripting only)
• sol2 (scripting only)
• lodepng (scripting only)
• nlohmann/json (scripting only)

Windows

Text in `` below are up to your choice but shall be replaced with the same choice every time the same text is contained.

MSVC++

Any recent version of Microsoft Visual C++ should work. Be sure to remember which version you chose as later on you will have to pick corresponding versions for other dependencies.

CMake

Any recent CMake version >= 3.18 should work. Just take the latest.

Qt5

Install Qt5 to ``

The recommended Qt version for noggit is 5.9, which can be downloaded from https://download.qt.io/new_archive/qt/5.9/5.9.9/qt-opensource-windows-x86-5.9.9.exe.

If you want to try a newer version, you can download the online installer from https://www.qt.io/download-open-source/#section-2.

Note that during installation you only need one version of Qt and also only one compiler version. If download size is noticably large (more than a few hundred MB), you're probably downloading way too much.

LuaJIT

(Not necessary if disabling NOGGIT_WITH_SCRIPTING)

• Clone luajit to `` using git: git clone https://luajit.org/git/luajit.git
• Open up the visual studio command prompt (cmd / powershell does NOT work)
  • The program is usually called something like "x64 Native Tools Command Prompt for VS 20xx"
  • Usually enough to search for "x64 native" in the windows start menu
  • It will open a command prompt that looks like the normal windows command prompt, but has a bunch of necessary visual studio variables set.
• Navigate to the /src (with the visual studio command prompt)
• Run "msvcbuild.bat" (with the visual studio command prompt)
• If successful, should give a message similar to === Successfully built LuaJIT for Windows/x64 ===

Noggit

• open CMake GUI
• set CMAKE_PREFIX_PATH (path) to "", e.g. "C:/Qt/5.6/msvc2015"
• set CMAKE_INSTALL_PREFIX (path) to an empty destination, e.g. "C:/Users/blurb/Documents/noggitinstall
• set LUA_INCLUDE_DIR to /src
• set LUA_LIBRARY to /src/lua51.lib
• configure, generate
• open solution with visual studio
• build ALL_BUILD
• build INSTALL

To launch noggit you will need the following DLLs from Qt loadable. Install them in the system, or copy them from C:/Qt/X.X/msvcXXXX/bin into the directory containing noggit.exe, i.e. CMAKE_INSTALL_PREFIX configured.

• release: Qt5Core, Qt5OpenGL, Qt5Widgets, Qt5Gui

• debug: Qt5Cored, Qt5OpenGLd, Qt5Widgetsd, Qt5Guid

• If using scripting, you will also need to copy /src/lua51.dll to CMAKE_INSTALL_PREFIX

Linux

These instructions assume a working directory ``, for example /home/myuser/

Dependencies

On Ubuntu you can install the building requirements using:

sudo apt install freeglut3-dev qt5-default libsdl2-dev libbz2-dev

LuaJIT

From ``, build luajit using:

git clone https://luajit.org/git/luajit.git
cd luajit
make
sudo make install
cd ..

/luajit should now exist.

Build Noggit

From ``, clone Noggit3 (change repo as needed):

git clone https://github.com/wowdev/noggit3

/noggit3 should now exist.

From , compile and build using the following commands. Note that should be written as the full path in the commands below. For example: cmake -DLUA_LIBRARIES=/home/myuser/luajit/src/libluajit.so -DLUA_INCLUDE_DIR=/home/myuser/luajit/src ../noggit3

mkdir build
cd build
cmake -DLUA_LIBRARIES=/luajit/src/libluajit.so -DLUA_INCLUDE_DIR=/luajit/src ../noggit3
make -j $(nproc)

Instead of make -j $(nproc) you may want to pick a bigger number than $(nproc), e.g. the number of CPU cores * 1.5.

From /build, if the build pass correctly without errors, you can install the default lua scripts using:

cp -r ../noggit3/scripts ./bin/scripts

You can now go into /build/bin and run noggit.

Note that make install will probably not work.

Building the Scripting documentation

To generate the scripting API documentation, install any new version of Node.js and run:

npm i -g [email protected] [email protected] [email protected]

Then, enter the "scripting" directory in this repository and run the following commands:

typedoc --disableSources --plugin typedoc-plugin-markdown --hideBreadcrumbs --out docs/api global.d.ts
rm docs/api/README.md

DEVELOPMENT

Feel free to ask the owner of the official repository (https://github.com/wowdev/noggit3) for write access or fork and post a pull request.

There is a bug tracker at https://github.com/wowdev/noggit3/issues which should be used.

Discord, as linked above, may be used for communication.

CODING GUIDELINES

Following is an example for file src/noggit/ui/foo_ban.hpp. .cpp files are similar.

…