NightFox’s Lib: Difference between revisions

NFlib
NFlib
General
Author	KnightFox (NightFox)
Type	Development Libraries
Version	1.0
License	Mixed
Last Updated	2023/05/14
Links
	Download
	Website
	Source

Revision as of 02:10, 14 Mayıs 2023

NightFox’s Lib is a library written in C that is developed to facilitate programming for the DS. Based on Libnds of devkitArm, our library contains functions witch make the use of backgrounds, sprites, collision maps, etc much easier.

Features

256 color tilemaps:
- You can load them from FAT or NitroFS, and you may load up to 32 in RAM.
- The size must be a multiple of 256 pixels.
- Extended palettes are supported (up to 16 palettes of 256 colors per bg).
- VRAM is setup so that you can use 96 KB for tiles and 32 KB for maps per screen.
- "Infinite maps" are supported, using the technique "bank swap", which keeps the map in RAM all the time and copies to VRAM only the part that is being shown. The only limitation is the tileset size, which must not be over 96 KB for all 4 layers.
- Scroll is supported, and parts of the map are loaded to VRAM as they are needed.
- It is possible to show or hide backgrounds, unload them from RAM, modify tiles in the map at runtime, change the palette, etc.
256 color sprites:
- You may load up to 256 objects (128 per screen) and 64 palettes.
- You can hide sprites, rotate them, change their size, flip them, etc.
- Animated sprites are supported, with no frame limit. You can choose if the frames are stored in VRAM or only the image being shown in that moment.
- It is possible to modify the palettes at runtime to create visual effects.
Text engine:
- Based on tiled backgrounds.
- It supports 8x8 and 8x16 pixel fonts.
- 256 color font are supported.
- You can use fonts already colored or you can define their colors at runtime.
- You can rotate them by 90 degrees and scroll them.
- You need to load a font per background layer that will use it.
Sound:
- Basic support to load RAW audio files from FAT or NitroFS.
- It uses libnds to play them.
- You can load up to 32 sounds to RAM.
Collision maps:
- The library supports collision maps that can be edited at runtime.
- Up to 32 mapx can be loaded at the same time in RAM.
8 and 16 bit backgrounds:
- Useful to display images with a higher detail that tiled maps.
- There are functions to load them and edit them.
- You may load up to 16 images in total.
- There is backbuffer support.
Media:
- The library supports loading 8, 16, and 24 bit BMP files.
3D sprites:
- They use the 3D engine of the console to display up to 256 sprites.
- The maximum size is 1024x1024.
- You may rotate them, scale them, and define up to 62 transparency configurations.
WiFi:
- Basic WiFi support.
- Functions for basic UDP communications.
Examples:
- Lots of examples are available to see how to use the library.
Documentation:
- Available in PDF format in English and Spanish.
License:
- The library is licensed under the MIT license.
- The assets in this repository are licensed under the CC-BY-4.0 license.
- The examples are licensed under the CC0 license.

User guide

Setup instructions for devkitPro

Clone this repository. Create a symbolic link to it inside the devkitPro folder in your system. For example, in Linux, create a symlink so that /opt/devkitpro/nflib points to the folder with NFlib:

ln -sT /path/to/nds_nflib /opt/devkitpro/nflib

If this doesn't work, copy the folder of NFlib to the devkitPro folder and rename it to nflib. Go to the nflib folder and type this on the terminal:

make

That's it! Go to the folder of any of the examples and try to build it with:

make

Setup instructions for BlocksDS

Clone this repository. If you have followed the tutorial of BlocksDS, you should have the compiler in your PATH. All you have to do is go to the folder of the repository and run:

make -f Makefile.blocksds install

That's it! Go to the folder of any of the examples and try to build it with:

make -f Makefile.blocksds

Changelog

1.00

Add original assets and conversion scripts to all examples.
Start using semver for the version number of the library.
Big cleanup of the library headers.
Switch documentation to Doxygen.
Move WiFi functions to the main library.
Added support for BlocksDS.

External links

Official website - https://nightfoxandco.com
GitHub - https://github.com/knightfox75/nds_nflib

@@ Line 4: / Line 4: @@
 |description=An alternative to PAlib.
 |author=KnightFox (NightFox)
-|lastupdated=2020/10/08
+|lastupdated=2023/05/14
 |type=Development Libraries
-|version=2020
+|version=1.0
 |license=Mixed
 |download=https://dlhb.gamebrew.org/dshomebrew/nflib.7z
@@ Line 15: / Line 15: @@
 NightFox’s Lib is a library written in C that is  developed to facilitate programming for the DS. Based on Libnds of devkitArm, our library contains functions witch make the use of backgrounds, sprites, collision maps, etc much easier.
-'''Note from developer:'''
+==Features==
+* 256 color tilemaps:
+** You can load them from FAT or NitroFS, and you may load up to 32 in RAM.
+** The size must be a multiple of 256 pixels.
+** Extended palettes are supported (up to 16 palettes of 256 colors per bg).
+** VRAM is setup so that you can use 96 KB for tiles and 32 KB for maps per screen.
+** &quot;Infinite maps&quot; are supported, using the technique &quot;bank swap&quot;, which keeps the map in RAM all the time and copies to VRAM only the part that is being shown. The only limitation is the tileset size, which must not be over 96 KB for all 4 layers.
+** Scroll is supported, and parts of the map are loaded to VRAM as they are needed.
+** It is possible to show or hide backgrounds, unload them from RAM, modify tiles in the map at runtime, change the palette, etc.
+* 256 color sprites:
+** You may load up to 256 objects (128 per screen) and 64 palettes.
+** You can hide sprites, rotate them, change their size, flip them, etc.
+** Animated sprites are supported, with no frame limit. You can choose if the frames are stored in VRAM or only the image being shown in that moment.
+** It is possible to modify the palettes at runtime to create visual effects.
+* Text engine:
+** Based on tiled backgrounds.
+** It supports 8x8 and 8x16 pixel fonts.
+** 256 color font are supported.
+** You can use fonts already colored or you can define their colors at runtime.
+** You can rotate them by 90 degrees and scroll them.
+** You need to load a font per background layer that will use it.
+* Sound:
+** Basic support to load RAW audio files from FAT or NitroFS.
+** It uses libnds to play them.
+** You can load up to 32 sounds to RAM.
+* Collision maps:
+** The library supports collision maps that can be edited at runtime.
+** Up to 32 mapx can be loaded at the same time in RAM.
+* 8 and 16 bit backgrounds:
+** Useful to display images with a higher detail that tiled maps.
+** There are functions to load them and edit them.
+** You may load up to 16 images in total.
+** There is backbuffer support.
+* Media:
+** The library supports loading 8, 16, and 24 bit BMP files.
+* 3D sprites:
+** They use the 3D engine of the console to display up to 256 sprites.
+** The maximum size is 1024x1024.
+** You may rotate them, scale them, and define up to 62 transparency configurations.
+* WiFi:
+** Basic WiFi support.
+** Functions for basic UDP communications.
+* Examples:
+** Lots of examples are available to see how to use the library.
+* Documentation:
+** Available in PDF format in English and Spanish.
+* License:
+** The library is licensed under the MIT license.
+** The assets in this repository are licensed under the CC-BY-4.0 license.
+** The examples are licensed under the CC0 license.
+==User guide==
+=== Setup instructions for devkitPro ===
+Clone this repository. Create a symbolic link to it inside the devkitPro folder in your system. For example, in Linux, create a symlink so that <code>/opt/devkitpro/nflib</code> points to the folder with NFlib:</p>
+<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto">
+<pre>ln -sT /path/to/nds_nflib /opt/devkitpro/nflib</pre>
+If this doesn't work, copy the folder of NFlib to the devkitPro folder and rename it to <code>nflib</code>.
+Go to the <code>nflib</code> folder and type this on the terminal:
+<pre>make</pre>
-The library has not been updated for an extended period of time, it does not work as-is in the [https://devkitpro.org/ latest versions of libNDS]. A recompile of the library using the latest version of libNDS solves the problem. In the library's own compressed file there is a directory to perform this recompilation.
+That's it! Go to the folder of any of the examples and try to build it with:
-==Features==
+<pre>make</pre>
-* Support for 256 color Tiled Backgrounds.
-* Support for 256 color Sprites.
+=== Setup instructions for BlocksDS ===
-* Text Engine.
+Clone this repository. If you have followed the tutorial of [https://github.com/blocksds/sdk BlocksDS], you should have the compiler in your <code>PATH</code>. All you have to do is go to the folder of the repository and run:</p>
-* Sound.
-* Collision maps.
+<pre>make -f Makefile.blocksds install</pre>
-* 8 and 16 bits backgrounds.
-* Media.
-* 3D Sprites.
-* WIFI.
-* Examples.
-* Documentation.
-==User guide==
+That's it! Go to the folder of any of the examples and try to build it with:</p>
-Inside the folder there is a folder LIB NF_LIB within folders icon, Makefile, Source and WiFi. In the root of your project (where the default makefile) ICON.BMP copy files and Makefile that may need (they are in separate folders).
-Then copy the entire contents of the source folder in your source folder. To use the library only have to include # include "nf_lib.h" in code and # include "nf_wifi.h" if want to use wifi.
+<pre>make -f Makefile.blocksds</pre>
-You will find a complete documentation in PDF, with a complete description of all functions.
+==Changelog==
+'''1.00'''
+* Add original assets and conversion scripts to all examples.
+* Start using semver for the version number of the library.
+* Big cleanup of the library headers.
+* Switch documentation to Doxygen.
+* Move WiFi functions to the main library.
+* Added support for BlocksDS.
 ==External links==