KDIS

Open source implementation of DIS (Distributed Interactive Simulation) IEEE 1278.1

Contributing

I would love to see your contribution :heart:

Development

Requirements

Name	Homepage	Required	Notes
`CXX Compiler`		:heavy_check_mark:	`GCC` \| `Clang` \| `MSVC`
`CMake`	<https://cmake.org>	:heavy_check_mark:	Version `>= 3.14`
`Clang Format`	<https://clang.llvm.org/docs/ClangFormat.html>	:x:
`Clang Tidy`	<https://clang.llvm.org/extra/clang-tidy>	:x:
`Cppcheck`	<https://github.com/danmar/cppcheck>	:x:
`Cpplint`	<https://github.com/cpplint/cpplint>	:x:	`pip install cpplint`
`cmake lang`	<https://github.com/cheshirekow/cmake_format>	:x:	`pip install cmakelang[YAML]`
`Doxygen`	<https://www.doxygen.nl>	:x:	Documentation

Build Options

Name	Description	Type	Default
`DIS_VERSION`	`DIS` version: `5` IEEE 1278.1-1995 `6` IEEE 1278.1A-1998 `7` IEEE 1278.1x-2012	`STRING`	`7`
`KDIS_USE_ENUM_DESCRIPTORS`	Enumeration descriptors. Allow `enum` values to be turned into their text labels. :warning: Increase the memory footprint of the library	`BOOL`	`TRUE`
`KDIS_BUILD_DOCS`	Build documentation	`BOOL`	`FALSE`
`KDIS_BUILD_EXAMPLES`	Build examples	`BOOL`	`FALSE`
`KDIS_BUILD_TESTS`	Build tests	`BOOL`	`FALSE`
`BUILD_SHARED_LIBS`	Build shared library	`BOOL`	`TRUE`

Build

Generate project

[!NOTE] Change build options' values as needed

cmake \
    -S . \
    -B ./build \
    -DCMAKE_BUILD_TYPE:STRING=Release \
    -DDIS_VERSION:STRING=7 \
    -DKDIS_USE_ENUM_DESCRIPTORS:BOOL=TRUE \
    -DBUILD_SHARED_LIBS:BOOL=TRUE \
    -DBUILD_DOCS:BOOL=FALSE \
    -DBUILD_EXAMPLES:BOOL=FALSE \
    -DBUILD_TESTS:BOOL=FALSE

Build project

[!NOTE] Change value of --config to match value of CMAKE_BUILD_TYPE
```
cmake \
    --build ./build \
    --config Release
```

Documentation

[!IMPORTANT] KDIS_BUILD_DOCS:BOOL=TRUE required

File index.html available under build/docs/html directory

More information can be found in docs/README.md

Examples

[!IMPORTANT] KDIS_BUILD_EXAMPLES:BOOL=TRUE required

More information can be found in examples/README.md

Scripts

More information can be found in scripts/README.md

Tests

[!IMPORTANT] KDIS_BUILD_TESTS:BOOL=TRUE required

[!NOTE] Change value of --build-config to match value of CMAKE_BUILD_TYPE

ctest \
    --verbose \
    --test-dir ./build/tests \
    --build-config Release

More information can be found in tests/README.md

License

This project is licensed under the BSD 2-Clause "Simplified" License
See LICENSE file for details

description	DIS(IEEE 1278.1) Fully Implemented in C++
homepage URL	http://kdis.sf.net
repository URL	https://git.code.sf.net/p/kdis/code
owner	stefan.naewe+ro@gmail.com
last change	Thu, 12 Oct 2023 15:21:34 +0000 (12 16:21 +0100)
last refresh	Thu, 21 Nov 2024 07:35:01 +0000 (21 08:35 +0100)
mirror URL	git://repo.or.cz/KDIS.git
	https://repo.or.cz/KDIS.git
	ssh://git@repo.or.cz/KDIS.git
bundle info	KDIS.git downloadable bundles
content tags	add:

2023-10-12	Karl Jones	Remove old changelogmaster	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-12	Karl Jones	Update CHANGELOG.md	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-12	Karl Jones	Merge pull request #12 from carlocorradini/new	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-12	Karl Jones	Merge remote-tracking branch 'Github/master' into new	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-12	Karl Jones	Update CHANGELOG.md	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-12	Karl Jones	Update KDIS_Change_Log.htm	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-11	carlocorradini	chore: removed clang-format-ignore	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-11	carlocorradini	docs: fix typo	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-11	carlocorradini	chore: fix clang-format and all cmake bool options...	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-11	carlocorradini	fix: cmake install and possible conflicting options	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-11	carlocorradini	docs: better readme	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-11	carlocorradini	chore: check script, readme and better clang-format...	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-10	carlocorradini	chore(ci): fix need deps	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-10	carlocorradini	chore(ci): fix build needs	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-10	carlocorradini	chore(ci): job dependency	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
2023-10-10	carlocorradini	chore(ci): removed macos	commit \| commitdiff \| tree \| snapshot (tar.gz zip)
...

13 months ago	master	log \| tree
8 years ago	tests/data-types	log \| tree
8 years ago	unit-tests	log \| tree
9 years ago	iff_layer_4	log \| tree