Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/olde-skuul/burgerlib

The Only Low Level Library you'll ever need
https://github.com/olde-skuul/burgerlib

Last synced: 5 days ago
JSON representation

The Only Low Level Library you'll ever need

Awesome Lists containing this project

README 

        
# Welcome to Burgerlib



[![License](https://img.shields.io/badge/License-MIT%20License-blue "License")](https://github.com/Olde-Skuul/burgerlib/blob/master/LICENSE) [![Docs](https://img.shields.io/readthedocs/burgerlib.svg "Documentation Status")](http://burgerlib.readthedocs.io)



## The only low level library you'll ever need



Burgerlib is a low level *operating system* library that presents a common API that operates the same on numerous mobile, desktop, and video game platforms. By using the library, it will allow near instant porting of an application written on one platform to another.



Burgerlib is not meant to be considered an engine, it's a framework on to which an engine can be created on top of and by using the common API, be compatible on dozens of platforms.



Filenames and paths are standardized, all text is UTF-8 regardless of platform. Display, input, audio, music, math, timers, atomics, and typedefs operate the same.



---



## Table of contents



* [How to build documentation](docs/markdowns/build_docs.md)

* [Character encoding and standardizing on UTF-8.](docs/markdowns/character_encoding.md)

* [Filesystem rules and prefixes](docs/markdowns/filemanager.md)

* [What is Burgerlib?](docs/what_is_burgerlib.md)

* [Building Burgerlib](docs/building.md)

* [Using Burgerlib](docs/using_burgerlib.md)

* [Compiler issues](docs/compiler_issues.md)

* [Platform defines](docs/defines.md)

* [Platform types](docs/platform_types.md)

* [White Papers](docs/white_papers.md)



---



## Python is required



[Python can be downloaded here.](https://www.python.org/downloads/)



After Python is installed, run ``pip install -r requirements.txt`` from the root folder. This will ensure ``buildme`` and other python scripts needed by the build system are present.



Once it is installed, run ``buildme`` to build everything in the root or projects folders, or ``buildme whatever.sln`` to build a specific project file. ``buildme`` will build all project files. ``cleanme`` will clean a folder of all temporary files.



## Windows prerequisites



### Open Watcom 1.9 for Dos and Windows 32 targets



To build with Open Watcom, download and install the compiler and set the environment variable ``WATCOM`` to point to the installation folder, usually ``C:\WATCOM``



[Download Open Watcom 1.9 here](http://openwatcom.org/ftp/install/open-watcom-c-win32-1.9.exe)



``` text

SHA-1 236ac33ebd463006be4ecd83d7ebea1c026eb55a

```



### Codewarrior 9.4 for Windows 32 target



To build with Metrowerks Codewarrior, download and install the compiler. To install, first run ``CW_Windows_9.2.exe`` and then install ``CW_Windows_9.4_Update.exe``. After installation, copy the file ``license.dat`` over the file **C:\\Program Files (x86)\\Metrowerks\\CodeWarrior\\license.dat** to update the license to a permanent one.



[Download Codewarrior 9.4 for Windows here](https://archive.org/details/cwpro9)



``` text

SHA-1 2a8a839aa34a0e7b8400004788f0cbc3db03f90e for CW_Windows_9.2.exe

SHA-1 6da8be8022bf96b9387b6b14980944092ed2fc46 for CW_Windows_9.4_Update.exe

```



### Current Visual Studio IDE



Download Visual Studio at [Visual Studio website](https://visualstudio.com). Visual Studio 2022 is recommended, however versions from 2003, 2005, all the way to 2022 is supported.



### Visual Studio 2003



Download these three ISO files,



1. [Disk 1](https://archive.org/download/vsnet2003/MSDN%20Visual%20Studio%20NET%202003%20-%20Enterprise%20Architect%20%28Disc%201%29%28Disc%202082%29%28May%202003%29%28X09-51498%29.ISO)

2. [Disk 2](https://archive.org/download/vsnet2003/MSDN%20Visual%20Studio%20NET%202003%20-%20Enterprise%20Architect%20%28Disc%202%29%28Disc%202083%29%28May%202003%29%28X09-51499%29.ISO)

3. [Prerequisites](https://archive.org/download/vsnet2003/MSDN%20Visual%20Studio%20NET%202003%20Prerequisites%20%28Disc%202072%29%28May%202003%29%28X09-51482%29.ISO)

4. [Service Pack 1](https://archive.org/download/Visual-Studio-.NET-2003-SP-1/VS7.1sp1-KB918007-X86.exe.zip)



---



## Tools locations for download



### Visual Studio code



[Download Visual Studio code here](https://code.visualstudio.com/)



### 7Zip



[Download 7Zip from here.](https://7-zip.org/)



### DirectX 9.0c SDK June 2010



This is needed to build Burgerlib Windows using older compilers.



[Download DirectX 9.0c SDK June 2010 here](https://www.microsoft.com/en-us/download/details.aspx?id=6812)



``` text

SHA-1 495ad05ae5fc4ecd76b53a69a35bacb66d958608

```



### Vulkan SDK



Needed for Windows builds.



[Download Vulkan SDK here](https://www.lunarg.com/vulkan-sdk/)



---



## Credits



* Rebecca Ann Heineman - most of the codebase

* Gary S. Brown - CRC32B

* Jean-loup Gailly - Original Zlib compressor

* Mark Adler - Original Zlib decompressor

* Thatcher Ulrich - Hash template

* Daniel Julius Bernstein - djb2 hash algorithm

* Matt Pritchard - SafePrint



## License



Copyright 1995-2024 by Rebecca Ann Heineman [[email protected]](mailto:[email protected]). Email all suggestions, corrections, optimizations and insults to her and she'll be eternally grateful.



It is released under an MIT Open Source license. Please see [**LICENSE**](https://raw.githubusercontent.com/Olde-Skuul/burgerlib/master/LICENSE) for license details. Yes, you can use it in a commercial title without paying anything, just give me a credit.



Please? It's not like I'm asking you for money!