Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 1.82 KB

README.md

File metadata and controls

21 lines (12 loc) · 1.82 KB
Raw

ScalaBuff is a Scala Protocol Buffers (protobuf) compiler. It takes .proto files and outputs valid Scala classes that can be used by your code to receive or send protobuf messages.

Both the ScalaBuff generator and the generated Scala classes depend on Google's Java runtime for Protocol Buffers, which is provided with ScalaBuff.

If you want to utilize ScalaBuff to generate your Scala classes from .proto sources, you'll need to either download the source or download the packaged JAR for your Scala version from the Sonatype OSS repository. If you download the sources, you can easily run it from SBT or by generating a fat Jar with sbt assembly:

$ sbt assembly
$ java -jar target/scala-2.11/scalabuff-compiler-assembly-1.4.0.jar --proto_path=INPUT_DIR --scala_out=OUTPUT_DIR

If you just want to use ScalaBuff-generated classes in your SBT-managed project, here's the dependency to add (located on the Sonatype OSS repository): "net.sandrogrzicic" %% "scalabuff-runtime" % "[desired_version]" The latest release is 1.4.0 with support for Scala 2.10 and 2.11.

If you'd like to use SBT with ScalaBuff to auto-generate Scala protobuf classes from .proto sources, try the sbt-scalabuff project.

The ScalaBuff Wiki contains more information. For API documentation, see the project Scaladoc.

For any questions or general discussion, you can use the ScalaBuff Google Group but please feel free to create new issues for bug reports or feature requests. Thanks!