Skip to content

Commit

Permalink
com.virtualmaker.rpc 1.0.0-preview.1 (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
StephenHodgson authored Apr 24, 2024
1 parent 84f24e7 commit fb1a8bc
Show file tree
Hide file tree
Showing 64 changed files with 1,818 additions and 269 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# For more information about CodeOwners see:
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

* @StephenHodgson
* @afarchy @StephenHodgson
2 changes: 0 additions & 2 deletions .github/FUNDING.yml

This file was deleted.

140 changes: 0 additions & 140 deletions InitializeTemplate.ps1

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) #CURRENT_YEAR# ProjectAuthor
Copyright (c) 2024 Virtual Maker Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

2 changes: 0 additions & 2 deletions ProjectScope.ProjectName/ProjectSettings/ProjectVersion.txt

This file was deleted.

44 changes: 35 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
# upm-template
# com.virtualmaker.rpc

A Unity package manager repository template for quickly creating and setting up new UPM package projects in Unity.
[![Discord](https://img.shields.io/discord/855294214065487932.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/VM9cWJ9rjH) [![openupm](https://img.shields.io/npm/v/com.virtualmaker.rpc?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.virtualmaker.rpc/) [![openupm](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fcom.virtualmaker.rpc)](https://openupm.com/packages/com.virtualmaker.rpc/)

## Getting Started
A Bidirectional RPC package for the [Unity](https://unity.com/) Game Engine.

1. Create a new repository in GitHub using this template
2. Clone to your local machine
3. Run the `InitializeTemplate.ps1` script from powershell, a command line, or terminal
4. Follow prompt instructions
5. Open in Unity to generate the missing meta files
6. Check in project to source control
## Installing

Requires Unity 2021.3 LTS or higher.

The recommended installation method is though the unity package manager and [OpenUPM](https://openupm.com/packages/com.virtualmaker.rpc).

### Via Unity Package Manager and OpenUPM

- Open your Unity project settings
- Select the `Package Manager`
![scoped-registries](images/package-manager-scopes.png)
- Add the OpenUPM package registry:
- Name: `OpenUPM`
- URL: `https://package.openupm.com`
- Scope(s):
- `com.virtualmaker.rpc`
- Open the Unity Package Manager window
- Change the Registry from Unity to `My Registries`
- Add the `VirtualMaker.RPC` package

### Via Unity Package Manager and Git url

- Open your Unity Package Manager
- Add package from git url: `https://github.com/virtual-maker-net/com.virtualmaker.rpc.git#upm`

## Documentation

### Project Setup

```csharp
// TODO
```
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions VirtualMaker.RPC/Assets/csc.rsp.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# com.virtualmaker.rpc

[![Discord](https://img.shields.io/discord/855294214065487932.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/VM9cWJ9rjH) [![openupm](https://img.shields.io/npm/v/com.virtualmaker.rpc?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.virtualmaker.rpc/) [![openupm](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fcom.virtualmaker.rpc)](https://openupm.com/packages/com.virtualmaker.rpc/)

A Bidirectional RPC package for the [Unity](https://unity.com/) Game Engine.

## Installing

Requires Unity 2021.3 LTS or higher.

The recommended installation method is though the unity package manager and [OpenUPM](https://openupm.com/packages/com.virtualmaker.rpc).

### Via Unity Package Manager and OpenUPM

- Open your Unity project settings
- Select the `Package Manager`
![scoped-registries](images/package-manager-scopes.png)
- Add the OpenUPM package registry:
- Name: `OpenUPM`
- URL: `https://package.openupm.com`
- Scope(s):
- `com.virtualmaker.rpc`
- Open the Unity Package Manager window
- Change the Registry from Unity to `My Registries`
- Add the `VirtualMaker.RPC` package

### Via Unity Package Manager and Git url

- Open your Unity Package Manager
- Add package from git url: `https://github.com/virtual-maker-net/com.virtualmaker.rpc.git#upm`

## Documentation

### Project Setup

```csharp
// TODO
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) #CURRENT_YEAR# ProjectAuthor
Copyright (c) 2024 Virtual Maker Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions VirtualMaker.RPC/Packages/com.virtualmaker.rpc/Runtime.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit fb1a8bc

Please sign in to comment.