better readme
This commit is contained in:
Youmu Liu
@@ -0,0 +1,155 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Nitload StgSharp Team
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
StgSharp program uses the following open source projects,
|
||||
I'd like to refer to them here and show my sincere appreciation,
|
||||
while the names are sorted in no particular order
|
||||
|
||||
1. GLFW
|
||||
|
||||
Remote repository on: https://www.glfw.org/
|
||||
|
||||
License of GLFW:
|
||||
|
||||
Copyright (c) 2002-2006 Marcus Geelnard
|
||||
|
||||
Copyright (c) 2006-2019 Camilla Löwy
|
||||
|
||||
This software is provided 'as-is',
|
||||
without any express or implied warranty.
|
||||
In no event will the authors be held liable for
|
||||
any damages arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it freely,
|
||||
subject to the following restrictions:
|
||||
|
||||
The origin of this software must not be misrepresented;
|
||||
you must not claim that you wrote the original software.
|
||||
If you use this software in a product, an acknowledgment
|
||||
in the product documentation would be appreciated but is not required.
|
||||
|
||||
Altered source versions must be plainly marked as such,
|
||||
and must not be misrepresented as being the original software.
|
||||
|
||||
This notice may not be removed or altered from any source distribution.
|
||||
|
||||
2. GLAD, Khronos Specifications and other Specification headers
|
||||
|
||||
Web service available on https://gen.glad.sh/
|
||||
|
||||
The glad source code:
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2013-2022 David Herberth
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
The Khronos Specifications:
|
||||
|
||||
Copyright (c) 2013-2020 The Khronos Group Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
3. docs.gl
|
||||
|
||||
4. Terminal.GUI
|
||||
|
||||
Remote repository on: https://github.com/gui-cs/Terminal.Gui
|
||||
|
||||
License of Terminal.GUI:
|
||||
|
||||
Copyright 2007-2011 Novell Inc
|
||||
Copyright 2017 Microsoft Corp
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
5. IxMilia.Step
|
||||
|
||||
License of IxMilia.Step:
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) IxMilia.
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,11 +1,222 @@
|
||||
# Stg# #
|
||||
# StgSharp
|
||||
|
||||
Stg# is the new generation STG game engine. STG# is written in C# and runs on .NET platform.
|
||||
|
||||
|
||||
The Stg# engine contains three parts:
|
||||
StgSharp is a modern C# framework that combines game engine capabilities with high-performance computing features. Originally designed as a next-generation STG (Shoot 'em Up) game engine, it has evolved to include advanced mathematical libraries, parallel computing capabilities, and comprehensive graphics APIs.
|
||||
|
||||
1. A high efficiency math library
|
||||
2. A timeline manager
|
||||
3. A game resource manager
|
||||
## Overview
|
||||
|
||||
Timeline of Stg# is controlled by a new type of scipt language called SGSL(Shooting Game Script Language). SGSL allows developers to manage files and debug in an reletively easy mod. Developers edit games in different "Organizations", which can be devided into "Generatings" and "Processings", which defines how bollet creats and move.
|
||||
StgSharp provides both low-level and high-level bindings to OpenGL, multimedia control, and device management, offering everything needed to create STG games and high-performance applications. The framework is built on .NET 8 and supports Windows and Linux platforms.
|
||||
|
||||
## Core Modules
|
||||
|
||||
### StgSharp.Common
|
||||
The main library containing core functionality:
|
||||
|
||||
- **Mathematics**: High-performance linear algebra, matrix operations, and mathematical utilities
|
||||
- **Graphics**: OpenGL bindings, rendering pipeline, and graphics framework
|
||||
- **High Performance**: SIMD operations, memory management, and parallel computing
|
||||
- **Collections**: Specialized data structures and containers
|
||||
- **MVVM**: Model-View-ViewModel framework for UI applications
|
||||
- **Entities**: Game entity system and behavior management
|
||||
- **Environment**: Platform abstraction and system integration
|
||||
|
||||
### StgSharp.Script
|
||||
General-purpose syntax analysis framework:
|
||||
|
||||
- **Syntax Analysis Framework**: Provides a flexible framework for parsing and analyzing various programming languages
|
||||
- **EXPRESS Language Support**: Specialized support for ISO 10303-11 EXPRESS language syntax parsing
|
||||
- **Abstract Syntax Trees**: Language parsing and analysis infrastructure
|
||||
- **Token Processing**: Lexical analysis and token management
|
||||
- **Grammar Parsing**: Extensible grammar parsing and validation system
|
||||
|
||||
### StgSharp.Model
|
||||
Geometric model loading and interpretation:
|
||||
|
||||
- **Geometric Model Loading**: Responsible for loading and interpreting geometric models from various formats
|
||||
- **STEP Format Support**: Limited support for ISO 10303 STEP file format processing
|
||||
- **Entity Management**: Model entity parsing and geometric data interpretation
|
||||
- **Data Pipeline**: Efficient geometric data processing and transformation
|
||||
- **Schema Validation**: Model structure validation and verification
|
||||
|
||||
### StgSharp.Native
|
||||
Native library integration:
|
||||
|
||||
- **GLFW Integration**: Cross-platform window and input management
|
||||
- **SIMD Operations**: Hardware-accelerated vector operations
|
||||
- **Matrix Kernels**: Optimized matrix computation routines
|
||||
- **Context Management**: Graphics context and resource management
|
||||
|
||||
### StgSharp.TerminalDialogue
|
||||
Terminal-based user interface:
|
||||
|
||||
- **Interactive Terminal**: Command-line interface components
|
||||
- **Dialogue System**: User interaction and input handling
|
||||
- **Terminal Graphics**: Text-based UI rendering
|
||||
|
||||
## Key Features
|
||||
|
||||
### High-Performance Computing
|
||||
- **Parallel Matrix Operations**: Multi-threaded matrix computations with optimized scheduling
|
||||
- **SIMD Acceleration**: Hardware-optimized vector operations
|
||||
- **Memory Management**: Custom allocators including HLSF (Hybrid Layer Segregated Fit)
|
||||
- **Thread Pool Management**: Efficient task scheduling and execution
|
||||
|
||||
### Graphics and Rendering
|
||||
- **OpenGL Integration**: Complete OpenGL API coverage
|
||||
- **Cross-Platform Support**: Windows and Linux compatibility
|
||||
- **Rendering Pipeline**: Flexible and extensible graphics framework
|
||||
- **Shader Management**: Dynamic shader compilation and management
|
||||
|
||||
### Game Engine Capabilities
|
||||
- **Entity System**: Flexible game object management
|
||||
- **State Machine**: Game state and behavior management
|
||||
- **Input Handling**: Comprehensive input and control systems
|
||||
- **Resource Management**: Efficient asset loading and management
|
||||
|
||||
### Data Processing
|
||||
- **STEP File Support**: Industrial data format processing
|
||||
- **EXPRESS Language**: Domain-specific language compilation
|
||||
- **Pipeline Processing**: Efficient data transformation workflows
|
||||
|
||||
## Documentation
|
||||
|
||||
### Technical Documentation
|
||||
- [HLSF Allocator](StgSharp.Common/HighPerformance/Memory/InroductionToHLSF.md) - High-performance memory allocator documentation
|
||||
- [Native Library Naming](StgSharp.Native/naming.md) - Native library file naming conventions
|
||||
|
||||
### Module-Specific Documentation
|
||||
- **Mathematics**: Linear algebra, matrix operations, and mathematical utilities
|
||||
- **Graphics**: OpenGL bindings, rendering, and graphics pipeline
|
||||
- **High Performance**: SIMD operations, parallel computing, and memory management
|
||||
- **Scripting**: General syntax analysis framework with EXPRESS language support
|
||||
- **Modeling**: Geometric model loading and interpretation with STEP format support
|
||||
|
||||
## Requirements
|
||||
|
||||
- .NET 8.0 or later
|
||||
- Windows 10/11 or Linux
|
||||
- x64 or ARM64 architecture
|
||||
- OpenGL 3.3+ support
|
||||
|
||||
## Installation
|
||||
|
||||
StgSharp is currently in development and requires compilation from source. **NuGet packages are not yet available** - you must build the project from source code.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Windows**: Visual Studio 2022 or later with C++ development tools
|
||||
- **Linux**: CMake and compatible C++ compiler (planned support)
|
||||
- .NET 8.0 SDK or later
|
||||
- Git for source code retrieval
|
||||
|
||||
### Building from Source
|
||||
|
||||
1. **Clone the repository**:
|
||||
```bash
|
||||
git clone https://github.com/Nitload-NSI/StgSharp.git
|
||||
cd StgSharp
|
||||
```
|
||||
|
||||
2. **Windows (Recommended)**:
|
||||
- Open `StgSharp.sln` in Visual Studio
|
||||
- Build the solution (Debug or Release configuration)
|
||||
- The native components will be automatically compiled
|
||||
|
||||
3. **Linux (Experimental)**:
|
||||
```bash
|
||||
# Build .NET components only
|
||||
# Note: Native components are not yet supported on Linux
|
||||
dotnet build
|
||||
```
|
||||
|
||||
### Build Configuration
|
||||
|
||||
- **Debug**: Full debugging symbols, unoptimized
|
||||
- **Release**: Optimized for performance
|
||||
|
||||
### Notes
|
||||
|
||||
- Windows compilation with Visual Studio is fully supported and tested
|
||||
- Linux support is experimental and limited to .NET components only
|
||||
- Native components (StgSharp.Native) are currently Windows-only and require MSVC
|
||||
- CMake support for native components is not yet implemented
|
||||
- Some features may not be available on all platforms
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Basic Graphics Application
|
||||
|
||||
```csharp
|
||||
|
||||
/*To be implemented*/
|
||||
|
||||
```
|
||||
|
||||
### Matrix Operations
|
||||
|
||||
```csharp
|
||||
using StgSharp.Mathematics;
|
||||
|
||||
// Create matrices
|
||||
var matrixA = Matrix<float>.Create(4, 4);
|
||||
var matrixB = Matrix<float>.Create(4, 4);
|
||||
|
||||
// Perform parallel matrix multiplication
|
||||
var result = matrixA * matrixB;
|
||||
```
|
||||
|
||||
### Memory Management
|
||||
|
||||
```csharp
|
||||
using StgSharp.HighPerformance.Memory;
|
||||
|
||||
// Create high-performance allocator
|
||||
using var allocator = new HybridLayerSegregatedFitAllocator(64 * 1024 * 1024);
|
||||
|
||||
// Allocate memory
|
||||
var handle = allocator.Alloc(1024);
|
||||
// Use allocated memory
|
||||
allocator.Free(handle);
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
StgSharp follows a modular architecture where each component can be used independently or in combination:
|
||||
|
||||
- **Core Layer**: Fundamental data structures and utilities
|
||||
- **Graphics Layer**: Rendering and graphics APIs
|
||||
- **Performance Layer**: High-performance computing and optimization
|
||||
- **Application Layer**: Game engine and application frameworks
|
||||
- **Data Layer**: File processing and data modeling
|
||||
|
||||
## Performance Characteristics
|
||||
|
||||
- **Matrix Operations**: Optimized for large-scale computations
|
||||
- **Memory Allocation**: O(1) allocation and deallocation with HLSF
|
||||
- **Parallel Processing**: Multi-threaded execution with intelligent scheduling
|
||||
- **SIMD Utilization**: Hardware-accelerated vector operations
|
||||
|
||||
## Contributing
|
||||
|
||||
StgSharp is developed by Nitload Space. Contributions are welcome, particularly in:
|
||||
|
||||
- Performance optimizations
|
||||
- Cross-platform compatibility
|
||||
- Documentation improvements
|
||||
- New feature implementations
|
||||
|
||||
## License
|
||||
|
||||
StgSharp is licensed under the MIT License. See [LICENSE](LICENSE) for details.
|
||||
|
||||
## Future Plans
|
||||
|
||||
- **Vulkan Support**: Planned for version 2.0
|
||||
- **Enhanced Cross-Platform**: Improved Linux and mobile support
|
||||
- **Performance Optimizations**: Further SIMD and parallel processing improvements
|
||||
- **Extended Language Support**: Additional domain-specific languages
|
||||
|
||||
## Support
|
||||
|
||||
For questions, issues, or contributions, please refer to the project repository or contact the development team.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
Reference in New Issue
Block a user