Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!-- Thanks for sending a pull request! Here are some tips for you:

1. If this is your first time, please read our contributor guidelines: https://github.com/googleforgames/quilkin/blob/main/CONTRIBUTING.md
and developer guide https://github.com/googleforgames/quilkin/blob/main/build/README.md
1. If this is your first time, please read our contributor guidelines: https://github.com/EmbarkStudios/quilkin/blob/main/CONTRIBUTING.md
and developer guide https://github.com/EmbarkStudios/quilkin/blob/main/build/README.md
2. Please label this pull request according to what type of issue you are addressing.
3. Ensure you have added or ran the appropriate tests for your PR: https://github.com/googleforgames/quilkin/blob/main/build/README.md#run-tests
3. Ensure you have added or ran the appropriate tests for your PR: https://github.com/EmbarkStudios/quilkin/blob/main/build/README.md#run-tests
-->

**What type of PR is this?**
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ If you have a feature you'd like to request that doesn't have an existing issue,

Participation in this project comes under the [Contributor Covenant Code of Conduct](code-of-conduct.md)

[unassigned "help wanted" issues.]: https://github.com/googleforgames/quilkin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22%20no%3Aassignee
[github discussions]: https://github.com/googleforgames/quilkin/discussions
["Feature Request"]: https://github.com/googleforgames/quilkin/issues/new?template=feature_request.md
[unassigned "help wanted" issues.]: https://github.com/EmbarkStudios/quilkin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22%20no%3Aassignee
[github discussions]: https://github.com/EmbarkStudios/quilkin/discussions
["Feature Request"]: https://github.com/EmbarkStudios/quilkin/issues/new?template=feature_request.md

## Repository Layout

Expand Down Expand Up @@ -45,7 +45,7 @@ See our [Quilkin Development and Building Guide](./build/README.md) for developi
- We follow the [GitHub Pull Request Model](https://help.github.com/articles/about-pull-requests/) for
all contributions.
- For large bodies of work, we recommend creating an issue and labelling it
"[kind/design](https://github.com/googleforgames/quilkin/issues?q=is%3Aissue+is%3Aopen+label%3Akind%2Fdesign)"
"[kind/design](https://github.com/EmbarkStudios/quilkin/issues?q=is%3Aissue+is%3Aopen+label%3Akind%2Fdesign)"
outlining the feature that you wish to build, and describing how it will be implemented. This gives a chance
for review to happen early, and ensures no wasted effort occurs.
- For new features, documentation *must* be included. Documentation can currently be found under
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ authors = [
]
license.workspace = true
description = "Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game server deployments, to ensure security, access control, telemetry data, metrics and more."
homepage = "https://github.com/googleforgames/quilkin"
repository = "https://github.com/googleforgames/quilkin"
homepage = "https://github.com/EmbarkStudios/quilkin"
repository = "https://github.com/EmbarkStudios/quilkin"
readme = "README.md"
keywords = [
"proxy",
Expand Down
4 changes: 2 additions & 2 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ We welcome development from the community on Quilkin!
We use several submodules, so make sure you have them downloaded and updated.

```shell script
git clone https://github.com/googleforgames/quilkin.git
git clone https://github.com/EmbarkStudios/quilkin.git
cd quilkin
git submodule update --init --recursive
```

You will likely want to replace `https://github.com/googleforgames/quilkin.git` with your own fork of the repository
You will likely want to replace `https://github.com/EmbarkStudios/quilkin.git` with your own fork of the repository
for your development.

### Developing with Rust tooling
Expand Down
4 changes: 2 additions & 2 deletions build/templates/github-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ This is the {version} release of Quilkin.

{ write description of release }

Check the [documentation](https://github.com/googleforgames/quilkin#documentation) for details on features, installation and
Check the [documentation](https://github.com/EmbarkStudios/quilkin#documentation) for details on features, installation and
usage.

**Implemented enhancements:**

{ insert enhancements from the changelog and/or security and breaking changes }

See [CHANGELOG](https://github.com/googleforgames/quilkin/blob/release-{version}/CHANGELOG.md) for more details on changes.
See [CHANGELOG](https://github.com/EmbarkStudios/quilkin/blob/release-{version}/CHANGELOG.md) for more details on changes.

Images available with this release:

Expand Down
66 changes: 33 additions & 33 deletions build/templates/release-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Prerequisites

- [ ] Have at least `Editor` level access to `quilkin` Google Cloud project.
- [ ] Local gcloud configuration is pointing at the `quilkin` Google Cloud project.
- [ ] Local git remote `upstream` points at `[email protected]:googleforgames/quilkin.git`.
- [ ] Local gcloud configuration is pointing at the `quilkin` Google Cloud project.
- [ ] Local git remote `upstream` points at `[email protected]:EmbarkStudios/quilkin.git`.

## Steps

Expand All @@ -13,38 +13,38 @@
- [ ] Run `git remote update && git checkout main && git reset --hard upstream/main` to ensure your code is in line
with upstream.
- [ ] Update Cargo version for release
- [ ] Edit the `version` field in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `quilkin-macros` dependency in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `quilkin-proto` dependency in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `quilkin-xds` dependency in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `version` field in `./crates/macros/Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `version` field in `./crates/quilkin-proto/Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `version` field in `./crates/xds/Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `version` field in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `quilkin-macros` dependency in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `quilkin-proto` dependency in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `quilkin-xds` dependency in `./Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `version` field in `./crates/macros/Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `version` field in `./crates/quilkin-proto/Cargo.toml` and remove the `-dev` suffix.
- [ ] Edit the `version` field in `./crates/xds/Cargo.toml` and remove the `-dev` suffix.
- [ ] cd to `./build/release` and run `make` to submit the cloud build
- [ ] Download all the artifacts from the cloud build.
- [ ] Review `license.html` to ensure that there aren't any new MPL, or CDDL dependencies from the last
- [ ] Review `license.html` to ensure that there aren't any new MPL, or CDDL dependencies from the last
release. If there are:
- [ ] Add the dependencies to [archive_dependencies.sh](https://github.com/googleforgames/quilkin/blob/main/build/release/archive_dependencies.sh)
- [ ] Add the dependencies to [archive_dependencies.sh](https://github.com/EmbarkStudios/quilkin/blob/main/build/release/archive_dependencies.sh)
so that the source is archived in the container image.
- [ ] Reset checklist back to "run `make` to submit the cloud build", and start from there again.
- [ ] Reset checklist back to "run `make` to submit the cloud build", and start from there again.
- [ ] Run `cd crates/macros && cargo publish --dry-run --allow-dirty` and ensure there are no issues.
- [ ] Run `cd crates/quilkin-protos && cargo publish --dry-run --allow-dirty` and ensure there are no issues.
- [ ] Run `cd crates/xds && cargo publish --dry-run --allow-dirty` and ensure there are no issues.
- [ ] Run `cargo publish --dry-run --allow-dirty` and ensure there are no issues.
- [ ] Run `cargo clippy` in the root directory, and ensure there are no issues.
- [ ] Add a release item to README.md "Documentation" > "Releases" list with related links in reverse chronological
- [ ] Add a release item to README.md "Documentation" > "Releases" list with related links in reverse chronological
order.
- [ ] Review any `data-proofer-ignore` attributes from links in the documentation in `./docs`, and remove any no
- [ ] Review any `data-proofer-ignore` attributes from links in the documentation in `./docs`, and remove any no
longer needed.
- [ ] Update all yaml files in to `./examples` to the next release version.
- [ ] Create a draft [Github release](https://github.com/googleforgames/quilkin/releases/new)
- [ ] Populate the tag with `v{version}`
- [ ] Click `Generate release notes` to generate the change log for this release.
- [ ] Copy the release notes from the draft release and paste it at the top of CHANGELOG.md.
- [ ] Using the
[Github release template](https://github.com/googleforgames/quilkin/blob/main/build/templates/github-release.md)
- [ ] Create a draft [Github release](https://github.com/EmbarkStudios/quilkin/releases/new)
- [ ] Populate the tag with `v{version}`
- [ ] Click `Generate release notes` to generate the change log for this release.
- [ ] Copy the release notes from the draft release and paste it at the top of CHANGELOG.md.
- [ ] Using the
[Github release template](https://github.com/EmbarkStudios/quilkin/blob/main/build/templates/github-release.md)
update the generated release notes with a description, and relevant changelog sections.
- [ ] Attach all the cloud build artifacts to the draft GitHub release.
- [ ] Attach all the cloud build artifacts to the draft GitHub release.
- [ ] Submit these changes as a PR, and merge with approval.
- [ ] Run `git remote update && git checkout main && git reset --hard upstream/main` to ensure your code is in line
with upstream.
Expand All @@ -54,22 +54,22 @@
- [ ] Submit the release.
- [ ] Post announcemnts
- [ ] [mailing list](https://groups.google.com/g/quilkin-discuss).
- [ ] [Discord #announcement](https://discord.com/channels/773975408265134100/879794098721140786)
- [ ] [Discord #announcement](https://discord.com/channels/773975408265134100/879794098721140786)
- [ ] [Twitter account](https://twitter.com/quilkindev).
- [ ] Update Cargo version for development
- [ ] Edit `Cargo.toml` and increment the [minor version](https://semver.org/) and apply the `-dev` suffix to the
`version`.
- [ ] Edit the `quilkin-macros` dependency in `./Cargo.toml` and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `quilkin-protos` dependency in `./Cargo.toml` and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `quilkin-xds` dependency in `./Cargo.toml` and increment the [minor version](https://semver.org/)
- [ ] Edit `Cargo.toml` and increment the [minor version](https://semver.org/) and apply the `-dev` suffix to the
`version`.
- [ ] Edit the `quilkin-macros` dependency in `./Cargo.toml` and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `version` field in `./crates/macros/Cargo.toml`and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `version` field in `./crates/quilkin-protos/Cargo.toml`and increment the [minor version](https://semver.org/)
- [ ] Edit the `quilkin-protos` dependency in `./Cargo.toml` and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `version` field in `./crates/xds/Cargo.toml`and increment the [minor version](https://semver.org/)
- [ ] Edit the `quilkin-xds` dependency in `./Cargo.toml` and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `version` field in `./crates/macros/Cargo.toml`and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `version` field in `./crates/quilkin-protos/Cargo.toml`and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Edit the `version` field in `./crates/xds/Cargo.toml`and increment the [minor version](https://semver.org/)
and apply the `-dev` suffix to the `version`.
- [ ] Submit this change as a PR, and merge with approval.

Expand Down
4 changes: 2 additions & 2 deletions crates/macros/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ version = "0.10.0-dev"
authors = ["Erin Power <[email protected]>"]
license.workspace = true
description = "Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game server deployments, to ensure security, access control, telemetry data, metrics and more."
homepage = "https://github.com/googleforgames/quilkin"
repository = "https://github.com/googleforgames/quilkin"
homepage = "https://github.com/EmbarkStudios/quilkin"
repository = "https://github.com/EmbarkStudios/quilkin"
readme = "README.md"
keywords = ["proxy", "game-server", "game-development", "networking", "multiplayer"]
categories = ["game-development", "network-programming"]
Expand Down
2 changes: 1 addition & 1 deletion crates/macros/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quilkin Macros

Macros for https://github.com/googleforgames/quilkin.
Macros for https://github.com/EmbarkStudios/quilkin.

## Licence

Expand Down
4 changes: 2 additions & 2 deletions crates/quilkin-proto/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
name = "quilkin-proto"
version = "0.10.0-dev"
description = "Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game server deployments, to ensure security, access control, telemetry data, metrics and more."
homepage = "https://github.com/googleforgames/quilkin"
repository = "https://github.com/googleforgames/quilkin"
homepage = "https://github.com/EmbarkStudios/quilkin"
repository = "https://github.com/EmbarkStudios/quilkin"
edition.workspace = true
license.workspace = true

Expand Down
2 changes: 1 addition & 1 deletion crates/test/tests/token_router.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
use qt::xdp_util;
use quilkin::filters;

// This test covers the scenario in https://github.com/googleforgames/quilkin/issues/988
// This test covers the scenario in https://github.com/EmbarkStudios/quilkin/issues/988
// to make sure there are no issues with overlapping streams between clients.
#[tokio::test]
async fn multiple_clients() {
Expand Down
4 changes: 2 additions & 2 deletions crates/xds/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name = "quilkin-xds"
version = "0.10.0-dev"
description = "Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game server deployments, to ensure security, access control, telemetry data, metrics and more."
homepage = "https://github.com/googleforgames/quilkin"
repository = "https://github.com/googleforgames/quilkin"
homepage = "https://github.com/EmbarkStudios/quilkin"
repository = "https://github.com/EmbarkStudios/quilkin"
edition.workspace = true
license.workspace = true

Expand Down
6 changes: 3 additions & 3 deletions docs/src/deployment/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ each providing different capabilities and complexity tradeoffs.
Below captures several of the most useful and prevalent architectural patterns to give you inspiration
on how you can use Quilkin in your multiplayer game networking architecture.

These [examples](https://github.com/googleforgames/quilkin/tree/{{GITHUB_REF_NAME}}/examples)
These [examples](https://github.com/EmbarkStudios/quilkin/tree/{{GITHUB_REF_NAME}}/examples)
as well many others are available on Github repository.

## [Server Proxy as a Sidecar](https://github.com/googleforgames/quilkin/tree/{{GITHUB_REF_NAME}}/examples/agones-xonotic-sidecar)
## [Server Proxy as a Sidecar](https://github.com/EmbarkStudios/quilkin/tree/{{GITHUB_REF_NAME}}/examples/agones-xonotic-sidecar)

```text
|
Expand Down Expand Up @@ -85,7 +85,7 @@ advantage of Client Proxy functionality.
* The Game Client will need to communicate to the Client Proxy what IP it should connect to when the Client is
match-made with a Game Server.

## [Client Proxy to Separate Server Proxies Pools](https://github.com/googleforgames/quilkin/tree/{{GITHUB_REF_NAME}}/examples/agones-xonotic-xds)
## [Client Proxy to Separate Server Proxies Pools](https://github.com/EmbarkStudios/quilkin/tree/{{GITHUB_REF_NAME}}/examples/agones-xonotic-xds)

```text
| |
Expand Down
Loading
Loading