Skip to content

Commit e061384

Browse files
author
game-workstore-bot
committed
Updated README.md
1 parent 6b57cd5 commit e061384

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Google Protobuf C# Library for Unity
22

3-
Unity NPM version of Google Protobuf! This repository applies the same APACHE 2.0 license terms of the original version.
3+
Unity NPM version of Google Protobuf! This repository applies the same license terms of the original version.
44

5-
Original repo: https://github.com/protocolbuffers/protobuf
5+
Original repo: [protocolbuffers](https://github.com/protocolbuffers/protobuf)
66

77
# Current Version
88

9-
You can find at CHANGES.txt
9+
You can find at Assets/Package/CHANGES.txt
1010

1111
# Updating this package:
1212

@@ -15,18 +15,32 @@ To do this:
1515

1616
1) Replace Google.Protobuf folder for the original Root > csharp > src > Google.Protobuf
1717
2) Replace CHANGES.txt for the original at Root.
18-
3) Replace Bin/protoc.exe for the Windows 64 bits version from original repo.
18+
3) Replace Assets/Package/Protoc/{versions} for related OS versions (current MacOS 64, Windows 64 and Linux 64) from original repo.
1919

2020
# How to install
2121

2222
At package.json, add these line of code:
23-
> "com.gameworkstore.googleprotobufcsharp": "git://github.com:GameWorkstore/googleprotobufcsharp.git"
23+
> "com.gameworkstore.googleprotobufunity": "git://github.com:GameWorkstore/google-protobuf-unity.git"
2424
2525
And wait for unity to download and compile the package.
2626

27-
for update package for a newer version, click in [Help->PackageUpdate->GameWorkstore.GoogleProtobufCsharp]
27+
for update package for a newer version, install UpmGitExtension and update on [ Window > Package Manager ]!
28+
> https://github.com/mob-sakai/UpmGitExtension
2829
2930
# Preinstalled Protoc
3031

3132
The installed version of protoc is Windows 64 bits.
3233

34+
# Configuration
35+
36+
There are two modes of configuration:
37+
38+
## Global
39+
You must configure at least a ProtobufConfig file anywhere in the project folder to allow the ProtobufCompiler to compile .proto files.
40+
This is the preferred one for simple projects.
41+
42+
## Local
43+
ProtobufCompiler also accepts multiple ProtobufConfig.
44+
Put one ProtobufConfig inside each folder containing your .proto files to allow it find them and compile on each custom path properly.
45+
This method is used for a project with more complex configurations or sub-projects inside Assets folder.
46+

0 commit comments

Comments
 (0)