cpp_minjson - Minimal JSON Library in C++20

Minimal JSON Serializer/Parser in C++20 for Game Development

A high-performance, header-only JSON parser and serializer library designed for C++20. This library is optimized for real-time applications, such as game development, where speed and low memory overhead are crucial.

Features

• Header-Only: Easy to integrate into any project without additional dependencies.
• Modern C++20: Leverages C++20 features like std::string_view, std::variant, and constexpr functions for maximum performance and flexibility.
• Efficient Parsing and Serialization: Designed to minimize memory allocations and provide fast JSON parsing and serialization.
• Cross-Platform Compatibility: Works on any platform with a modern C++20 compiler.

Getting Started

Prerequisites

• A C++20 compliant compiler (e.g., GCC 10+, Clang 10+, MSVC 19.26+).
• CMake 3.15+ (if using the provided CMakeLists.txt).

Installation

1. Clone the Repository:

   git clone https://github.com/Autodidac/cpp_minjson.git
   cd cpp_minjson

Include the Library:

Copy the include/cpp_minjson.hpp file into your project and include it in your source files:

#include "cpp_minjson.hpp"

Usage Here's a basic example demonstrating how to parse and serialize JSON:

#include "cpp_minjson.hpp"
#include <iostream>

int main() {
    // Example JSON string to parse
    std::string json_str = R"({
        "name": "John",
        "age": 30,
        "is_student": false,
        "courses": ["Math", "Science"]
    })";

    std::string_view json_view(json_str);

    // Parse JSON
    cpp_minjson::JsonValue value;
    try {
        value = cppjson::parse_value(json_view);
    } catch (const cpp_minjson::JsonParseException& e) {
        std::cerr << "Parsing error: " << e.what() << std::endl;
        return 1;
    }

    // Serialize JSON back to string
    std::string serialized = cpp_minjson::serialize(value);
    std::cout << "Serialized JSON: " << serialized << std::endl;

    return 0;
}

Building the Example If you want to build the example provided in src/main.cpp:

1. Generate the Build Files:

cmake -B build

2. Build the Project:

cmake --build build

3. Run the Example:

./build/main

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss improvements or bugs.

Acknowledgments

This library was inspired by the need for a lightweight, efficient JSON parser for game development and other real-time applications.

Contact

GitHub: Autodidac

Summary

• The README.md provides an overview of the Minimal JSON Library, installation instructions, usage examples, and build instructions using CMake.
• The example in main.cpp demonstrates parsing a JSON string, accessing its elements, serializing it back to a string, and saving it to a file.
• This Minimal JSON Library is designed for efficiency, using modern C++20 features to provide a lightweight solution for JSON parsing and serialization in real-time applications like games.