Skip to content

Commit

Permalink
Update license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bartl committed Feb 26, 2018
1 parent 13faa2a commit 13b3bcf
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 13 deletions.
45 changes: 45 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,48 @@
BEPUPhysicsint License:
==========================================================================

Copyright (C) 2018 Bartholomäus Steinmayr

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.

FixedMath.Net License:
==========================================================================

Copyright 2012 André Slupik

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.


libfixmath License:
==========================================================================

Copyright (C) 2012 Petteri Aimonen
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.

BEPUPhysics License:
==========================================================================
Apache License
Expand Down
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,27 @@
# BEPUphysics v1

*Looking for the newer bepuphysics v2? Head over to its [repository](https://github.com/bepu/bepuphysics2).*
*This is a fork of the awesome [bepuphysics v1](https://github.com/bepu/bepuphysics1)*

BEPUphysics is a pure C# 3D physics library by [BEPU](http://bepuphysics.com). It's fast and has a bunch of cool features like constraints, terrain, static and instanced meshes, continuous collision detection, custom collision rules, vehicles, easy multithreading, yadda yadda yadda.

Stuff you'll find in this repository:
BEPUphysicsint is a fork that uses the [FixedMath.net](https://github.com/asik/FixedMath.Net) fixed-point integer math instead of floats. This ensures full cross-platform determinism of the physics simulation.

1. [BEPUphysics](BEPUphysics), the physics simulation library
2. [BEPUik](BEPUik), the simulation-based inverse kinematics solver library
3. [BEPUphysicsDemos](BEPUphysicsDemos), the demonstration and test application for the above, along with its [debug renderer](BEPUphysicsDrawer).
4. [Documentation](Documentation/Documentation.md) and supplemental isolated demo applications.
This fork is (almost 100%) compatible with BEPUphysics, so please refer to the BEPUphysics [documentation page](Documentation/Documentation.md) for reference.

Just starting out? Check out the [Getting Started](Documentation/GettingStarted.md) tutorial in the documentation section.
# Known issues
* The value range of fixed point number is much more limited than float. As a result, the extent of the physics world should be limited to about 1000 on each axis. When the *CHECKMATH* compilation symbol is specified (e.g. in DEBUG builds), the math library will throw overflow exceptions.
* Performance. Currently this fork is about 4 times slower than the float version. Hopefully this will be improved soon, but the fixed-point version will definitely remain slower than the float version.

Check the [documentation page](Documentation/Documentation.md) for some deeper dives, isolated demos, and links to additional resources.

The library uses its own math libraries for cross platform development. The demo applications rely on [monogame](http://www.monogame.net/).

This repository contains the v1.X.X implementation of BEPUphysics that used to be hosted on [codeplex](https://bepuphysics.codeplex.com/). If you want some new fanciness, check out the [bepuphysics v2 repository](https://github.com/bepu/bepuphysics2).
# Determinism caveats
* Multithreading has to be disabled, otherwise the simulation will not be deterministic. See [InternalMultithreading](Documentation/InternalMultithreading.md#3a--determinism) for reference.
* Do not use floating point values when setting up the physics world. This probably also applies for collision meshes!

#
For discussions about BEPUphysics, please head to the [BEPUphysics forums](https://forum.bepuentertainment.com).

If you're looking for more BEPU-related stuff, head to the [main BEPU website](http://bepuphysics.com).

If you're feeling angelic, you can throw money at us:
If you're feeling angelic, you can throw money at the creators of BEPUphysics:

![](Documentation/images/readme/angelduck.png)

Expand Down

0 comments on commit 13b3bcf

Please sign in to comment.