Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxrdz/astron.libwasm
A free and open-source implementation of the Astron client protocol for C++ applications targeting Web Assembly.
https://github.com/maxrdz/astron.libwasm
astron cpp mmo networking object-oriented wasm web-assembly
Last synced: 15 days ago
JSON representation
A free and open-source implementation of the Astron client protocol for C++ applications targeting Web Assembly.
- Host: GitHub
- URL: https://github.com/maxrdz/astron.libwasm
- Owner: maxrdz
- License: bsd-3-clause
- Created: 2023-04-21T05:21:24.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-19T22:25:00.000Z (over 1 year ago)
- Last Synced: 2024-11-15T20:37:27.684Z (3 months ago)
- Topics: astron, cpp, mmo, networking, object-oriented, wasm, web-assembly
- Language: C++
- Homepage: https://github.com/Astron/Astron
- Size: 624 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
astron.libwasm
==============
  
An open-source implementation of the Astron client protocol for C++ applications targeting Web Assembly.
This implementation will only be targeting Web Assembly,
as it is portable to any operating system and any
architecture that is supported by a Javascript engine. (Chrome v8, NodeJS)
For the internal (server-side) implementation of Astron, check out [astron.libts](https://github.com/Max-Rodriguez/astron.libts).
# Building from Source
The following instructions assume that you're using a Linux based or Unix-like Operating System.
Before compiling the source code, you first need to generate the Makefile using CMake.
**NOTE:** You need to run `emcmake` to run cmake so that it sets the various
environment variables that are needed for CMake to generate for the em++ compiler.
**It is required** that you have the Emscripten SDK installed in your system
and added to your PATH in order to use the tools from the emsdk.
**On Linux:** To configure & build for release, run the following commands:
```bash
$ emcmake cmake . -Bbuild-release -DCMAKE_BUILD_TYPE=Release
$ cd build-release && make
```
CMake generates a Makefile by default. If you would like to use Ninja as
your generator, use the following shell command instead.
```bash
$ emcmake cmake . -GNinja -Bbuild-release -DCMAKE_BUILD_TYPE=Release
$ cd build-release && ninja
```
astron.libwasm is always compiled as a static library, not Web Assembly. It is compiled with Emscripten
so that your own application can be linked with this static library and target Web Assembly.
# Using Panda3D (webgl-port) in examples
I've built in the option to compile the example programs with the **WebGL** port of Panda3D.
This port of Panda can be viewed under the `webgl-port` branch of the Panda3D git repository.
[Link to the webgl-port branch.](https://github.com/panda3d/panda3d/tree/webgl-port)
This port of Panda targets Web Assembly. Due to its restrictions on the browser,
and current specification, Panda has to be built into static libraries.
It is then statically linked to the example program(s). You can view the
[CMakeLists.txt](./CMakeLists.txt) file and how it links with Panda.
Once you have the static libraries built, copy the `.a` (or `.lib`) files
over to the `example/` directory of this repository. Use the `-DUSE_PANDA=1` flag when compiling the examples.
Read the CMakeLists.txt file for specific instructions on where to move the generated Panda headers.
For instructions on building Panda3D for WebGL with Emscripten, see
[the building instructions](https://rdb.name/panda3d-webgl.md.html) written by rdb.
Feel free to also check out my [detailed build guide at the Panda3D discourse](https://discourse.panda3d.org/t/guide-to-using-c-panda3d-for-webgl-using-emscripten/29400).
# Troubleshooting
When using astron.libwasm, all output is flushed to the JavaScript console. In most browsers, pressing the F12 key should open this console.
**For astron.libwasm developers**, it is recommended that you compile with `-DCMAKE_BUILD_TYPE=Debug` as this disables
all compiler / linker optimizations and compiles with Clang's undefined behavior & address sanitizers (UBSan & ASan) for catching bugs faster.
There is a considerable performance and size penalty to doing this; expect a larger static library!
# Contributing
Before writing your first contribution, please make sure to read the [contributing guidelines](CONTRIBUTING.md).
**For astron.libwasm developers:** To regenerate the parser / lexer in `src/file`,
please use the bash script `lexparse.sh` inside the directory.
# Reporting Vulnerabilities
Please read the [security policy](SECURITY.md) document for more information on reporting software vulnerabilities.