2016-07-28 00:34:00 +00:00
|
|
|
![logo](http://google.github.io/flatbuffers/fpl_logo_small.png) FlatBuffers
|
2016-01-22 16:57:47 +00:00
|
|
|
===========
|
2016-07-28 00:34:00 +00:00
|
|
|
[![Build Status](https://travis-ci.org/google/flatbuffers.svg?branch=master)](https://travis-ci.org/google/flatbuffers) [![Build status](https://ci.appveyor.com/api/projects/status/yg5idd2fnusv1n10?svg=true)](https://ci.appveyor.com/project/gwvo/flatbuffers)
|
|
|
|
|
|
|
|
**FlatBuffers** is an efficient cross platform serialization library for games and
|
|
|
|
other memory constrained apps. It allows you to directly access serialized data without
|
|
|
|
unpacking/parsing it first, while still having great forwards/backwards compatibility.
|
2016-01-22 16:57:47 +00:00
|
|
|
|
|
|
|
**Go to our [landing page][] to browse our documentation.**
|
|
|
|
|
|
|
|
## Supported operating systems
|
|
|
|
* Android
|
|
|
|
* Windows
|
|
|
|
* MacOS X
|
|
|
|
* Linux
|
2016-07-28 00:34:00 +00:00
|
|
|
|
2016-01-22 16:57:47 +00:00
|
|
|
## Supported programming languages
|
|
|
|
* C++
|
|
|
|
* C#
|
2016-03-26 08:22:56 +00:00
|
|
|
* C
|
2016-01-22 16:57:47 +00:00
|
|
|
* Go
|
|
|
|
* Java
|
|
|
|
* JavaScript
|
|
|
|
* PHP
|
|
|
|
* Python
|
|
|
|
|
2016-02-01 18:48:00 +00:00
|
|
|
*and many more in progress...*
|
2016-01-22 16:57:47 +00:00
|
|
|
|
2016-07-28 00:34:00 +00:00
|
|
|
## Contribution
|
2016-01-22 16:57:47 +00:00
|
|
|
* [FlatBuffers Google Group][] to discuss FlatBuffers with other developers and users.
|
|
|
|
* [FlatBuffers Issues Tracker][] to submit an issue.
|
|
|
|
* [stackoverflow.com][] with [`flatbuffers` tag][] for any questions regarding FlatBuffers.
|
|
|
|
|
|
|
|
*To contribute to this project,* see [CONTRIBUTING][].
|
|
|
|
|
|
|
|
## Integration
|
2014-01-28 00:52:49 +00:00
|
|
|
For applications on Google Play that integrate this tool, usage is tracked.
|
|
|
|
This tracking is done automatically using the embedded version string
|
2016-01-22 16:57:47 +00:00
|
|
|
(**`flatbuffer_version_string`**), and helps us continue to optimize it. Aside from
|
2014-01-28 00:52:49 +00:00
|
|
|
consuming a few extra bytes in your application binary, it shouldn't affect
|
|
|
|
your application at all. We use this information to let us know if FlatBuffers
|
|
|
|
is useful and if we should continue to invest in it. Since this is open
|
|
|
|
source, you are free to remove the version string but we would appreciate if
|
|
|
|
you would leave it in.
|
|
|
|
|
2016-01-22 16:57:47 +00:00
|
|
|
## Licensing
|
|
|
|
*Flatbuffers* is licensed under the Apache License, Version 2.0. See [LICENSE][] for the full license text.
|
|
|
|
|
2015-12-04 04:30:54 +00:00
|
|
|
<br>
|
|
|
|
|
2016-07-16 04:26:50 +00:00
|
|
|
[CONTRIBUTING]: http://github.com/google/flatbuffers/blob/master/CONTRIBUTING.md
|
2015-12-04 04:30:54 +00:00
|
|
|
[`flatbuffers` tag]: https://stackoverflow.com/questions/tagged/flatbuffers
|
2016-03-08 23:57:12 +00:00
|
|
|
[FlatBuffers Google Group]: https://groups.google.com/forum/#!forum/flatbuffers
|
2015-12-04 04:30:54 +00:00
|
|
|
[FlatBuffers Issues Tracker]: http://github.com/google/flatbuffers/issues
|
|
|
|
[stackoverflow.com]: http://www.stackoverflow.com
|
|
|
|
[landing page]: http://google.github.io/flatbuffers
|
2016-01-22 16:57:47 +00:00
|
|
|
[LICENSE]: https://github.com/google/flatbuffers/blob/master/LICENSE.txt
|