nexproto

package module

v2.0.4 Latest Latest Go to latest Published: Sep 1, 2024 License: AGPL-3.0 Imports: 4 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/PretendoNetwork/nex-protocols-go

Links

Open Source Insights

README ¶

NEX Protocols Go

NEX servers with protocol support in Go

Other NEX libraries

nex-go - Barebones NEX/PRUDP server implementation

nex-protocols-common-go - NEX protocols used by many games with premade handlers and a high level API

Install

go get github.com/PretendoNetwork/nex-protocols-go/v2

Usage

nex-protocols-go provides a higher level API than the NEX Go module to the underlying PRUDP server by providing a set of NEX protocols. This module only provides access to the lower level raw RMC method calls, however, and all method handlers must be defined in full manually. For a higher level API, see the common NEX method handlers module

Example, friends (Wii U) authentication server

For a complete example, see the complete Friends Server, and other game servers

package main

import (
	nex "github.com/PretendoNetwork/nex-go/v2"
	ticket_granting "github.com/PretendoNetwork/nex-protocols-go/v2/ticket-granting"
)

var nexServer *nex.PRUDPServer

func main() {
	nexServer := nex.NewPRUDPServer()

	endpoint := nex.NewPRUDPEndPoint(1)
	endpoint.ServerAccount = nex.NewAccount(types.NewPID(1), "Quazal Authentication", "password"))
	endpoint.AccountDetailsByPID = accountDetailsByPID
	endpoint.AccountDetailsByUsername = accountDetailsByUsername

	nexServer.BindPRUDPEndPoint(endpoint)
	nexServer.SetFragmentSize(962)
	nexServer.LibraryVersions.SetDefault(nex.NewLibraryVersion(1, 1, 0))
	nexServer.SessionKeyLength = 16
	nexServer.AccessKey = "ridfebb9"

	ticketGrantingProtocol := ticket_granting.NewProtocol(endpoint)

	// Handle Login RMC method
	ticketGrantingProtocol.Login = login

	// Handle RequestTicket RMC method
	ticketGrantingProtocol.RequestTicket = requestTicket

	// Register the protocol on the endpoint
	endpoint.RegisterServiceProtocol(ticketGrantingProtocol)

	nexServer.Listen(60000)
}

Documentation ¶

Overview ¶

Package nexproto provides all the main NEX protocols.

Each folder contains a different package for that specific protocol, with all their types and methods needed to parse and build packets with RMC payloads

Source Files ¶

View all Source files

init.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
aa-user Package protocol implements the AAUser protocol	Package protocol implements the AAUser protocol
types Package types implements all the types used by the AAUser protocol	Package types implements all the types used by the AAUser protocol
account-management Package protocol implements the Account Management protocol	Package protocol implements the Account Management protocol
types Package types implements all the types used by the AccountManagement protocol	Package types implements all the types used by the AccountManagement protocol
datastore Package protocol implements the DataStore protocol	Package protocol implements the DataStore protocol
miitopia Package protocol implements the Miitopia DataStore protocol	Package protocol implements the Miitopia DataStore protocol
miitopia/types Package types implements all the types used by the DataStoreMiitopia protocol	Package types implements all the types used by the DataStoreMiitopia protocol
nintendo-badge-arcade Package protocol implements the Nintendo Badge Arcade DataStore protocol	Package protocol implements the Nintendo Badge Arcade DataStore protocol
nintendo-badge-arcade/types Package types implements all the types used by the DataStoreNintendoBadgeArcade protocol	Package types implements all the types used by the DataStoreNintendoBadgeArcade protocol
pokemon-bank Package protocol implements the DataStorePokemonBank protocol	Package protocol implements the DataStorePokemonBank protocol
pokemon-bank/types Package types implements all the types used by the DataStore protocol	Package types implements all the types used by the DataStore protocol
pokemon-gen6 Package protocol implements the DataStorePokemonGen6 protocol	Package protocol implements the DataStorePokemonGen6 protocol
pokemon-gen6/types Package types implements all the types used by the DataStore protocol	Package types implements all the types used by the DataStore protocol
super-mario-maker Package protocol implements the DataStoreSuperMarioMaker protocol	Package protocol implements the DataStoreSuperMarioMaker protocol
super-mario-maker/types Package types implements all the types used by the DataStore protocol	Package types implements all the types used by the DataStore protocol
super-smash-bros-4 Package protocol implements the Super Smash Bros.	Package protocol implements the Super Smash Bros.
super-smash-bros-4/types Package types implements all the types used by the DataStoreSuperSmashBros.4 protocol	Package types implements all the types used by the DataStoreSuperSmashBros.4 protocol
types Package types implements all the types used by the DataStore protocol	Package types implements all the types used by the DataStore protocol
debug Package protocol implements the Debug protocol	Package protocol implements the Debug protocol
friends Package protocol implements the Friends QRV protocol	Package protocol implements the Friends QRV protocol
types Package types implements all the types used by the Friends protocol	Package types implements all the types used by the Friends protocol
friends-3ds Package protocol implements the Friends 3DS protocol	Package protocol implements the Friends 3DS protocol
types Package types implements all the types used by the Friends3DS protocol	Package types implements all the types used by the Friends3DS protocol
friends-wiiu Package protocol implements the Friends WiiU protocol	Package protocol implements the Friends WiiU protocol
types Package types implements all the types used by the FriendsWiiU protocol	Package types implements all the types used by the FriendsWiiU protocol
globals Package globals implements variables and functions used by all protocol packages	Package globals implements variables and functions used by all protocol packages
health Package protocol implements the Health protocol	Package protocol implements the Health protocol
match-making Package protocol implements the Match Making protocol	Package protocol implements the Match Making protocol
constants
types Package types implements all the types used by the Matchmaking protocol	Package types implements all the types used by the Matchmaking protocol
match-making-ext Package protocol implements the Match Making Ext protocol	Package protocol implements the Match Making Ext protocol
matchmake-extension Package protocol implements the Matchmake Extension protocol	Package protocol implements the Matchmake Extension protocol
mario-kart-8 Package protocol implements the MatchmakeExtensionMarioKart8 protocol	Package protocol implements the MatchmakeExtensionMarioKart8 protocol
mario-kart-8/types Package types implements all the types used by the MatchmakeExtension protocol	Package types implements all the types used by the MatchmakeExtension protocol
monster-hunter-xx Package protocol implements the MatchmakeExtensionMonsterHunterXX protocol	Package protocol implements the MatchmakeExtensionMonsterHunterXX protocol
monster-hunter-xx/types Package types implements all the types used by the MatchmakeExtension protocol	Package types implements all the types used by the MatchmakeExtension protocol
pokemon-gen6 Package protocol implements the Pokemon GEN 6 Matchmake Extension protocol	Package protocol implements the Pokemon GEN 6 Matchmake Extension protocol
super-smash-bros-4 Package protocol implements the MatchmakeExtensionSuperSmashBros4 protocol	Package protocol implements the MatchmakeExtensionSuperSmashBros4 protocol
matchmake-referee Package protocol implements the Matchmake Referee protocol	Package protocol implements the Matchmake Referee protocol
types Package types implements all the types used by the MatchmakeReferee protocol	Package types implements all the types used by the MatchmakeReferee protocol
message-delivery Package protocol implements the Message Deliver protocol	Package protocol implements the Message Deliver protocol
messaging Package protocol implements the Messaging protocol	Package protocol implements the Messaging protocol
types Package types implements all the types used by the MessageDelivery protocol	Package types implements all the types used by the MessageDelivery protocol
monitoring Package protocol implements the Monitoring protocol	Package protocol implements the Monitoring protocol
nat-traversal Package protocol implements the NAT Traversal protocol	Package protocol implements the NAT Traversal protocol
nintendo-notifications Package protocol implements the Nintendo Notfications protocol	Package protocol implements the Nintendo Notfications protocol
types Package types implements all the types used by the NintendoNotifications protocol	Package types implements all the types used by the NintendoNotifications protocol
notifications Package protocol implements the Notifications protocol	Package protocol implements the Notifications protocol
types Package types implements all the types used by the Notifications protocol	Package types implements all the types used by the Notifications protocol
persistent-store Package protocol implements the NAT Traversal protocol	Package protocol implements the NAT Traversal protocol
ranking Package protocol implements the Ranking protocol	Package protocol implements the Ranking protocol
mario-kart-8 Package protocol implements the RankingMarioKart8 protocol	Package protocol implements the RankingMarioKart8 protocol
mario-kart-8/types Package types implements all the types used by the Ranking protocol	Package types implements all the types used by the Ranking protocol
splatoon Package protocol implements the RankingSplatoon protocol	Package protocol implements the RankingSplatoon protocol
types Package types implements all the types used by the Ranking protocol	Package types implements all the types used by the Ranking protocol
ranking2 Package protocol implements the Ranking2 protocol	Package protocol implements the Ranking2 protocol
types Package types implements all the types used by the Ranking2 protocol	Package types implements all the types used by the Ranking2 protocol
rating Package protocol implements the Rating protocol	Package protocol implements the Rating protocol
remote-log-device Package protocol implements the Remote Log Device protocol	Package protocol implements the Remote Log Device protocol
screening Package protocol implements the Screening protocol	Package protocol implements the Screening protocol
secure-connection Package protocol implements the Secure Connection protocol	Package protocol implements the Secure Connection protocol
nintendo-badge-arcade Package protocol implements the Nintendo Badge Arcade Secure Connection protocol	Package protocol implements the Nintendo Badge Arcade Secure Connection protocol
service-item Package protocol implements the Service Item protocol	Package protocol implements the Service Item protocol
team-kirby-clash-deluxe Package protocol implements the ServiceItemTeamKirbyClashDeluxe protocol	Package protocol implements the ServiceItemTeamKirbyClashDeluxe protocol
team-kirby-clash-deluxe/types Package types implements all the types used by the ServiceItem protocol	Package types implements all the types used by the ServiceItem protocol
wii-sports-club Package protocol implements the ServiceItemWiiSportsClub protocol	Package protocol implements the ServiceItemWiiSportsClub protocol
wii-sports-club/types Package types implements all the types used by the ServiceItem protocol	Package types implements all the types used by the ServiceItem protocol
shop Package protocol implements the Shop protocol	Package protocol implements the Shop protocol
nintendo-badge-arcade Package protocol implements the Nintendo Badge Arcade Shop protocol	Package protocol implements the Nintendo Badge Arcade Shop protocol
nintendo-badge-arcade/types Package types implements all the types used by the ShopNintendoBadgeArcade protocol	Package types implements all the types used by the ShopNintendoBadgeArcade protocol
types Package types implements all the types used by the Shop protocol	Package types implements all the types used by the Shop protocol
storage-manager Package protocol implements the StorageManager protocol	Package protocol implements the StorageManager protocol
subscriber Package protocol implements the Subscriber protocol	Package protocol implements the Subscriber protocol
types Package types implements all the types used by the Shop protocol	Package types implements all the types used by the Shop protocol
subscription Package protocol implements the Subscription protocol	Package protocol implements the Subscription protocol
ticket-granting Package protocol implements the Ticket Granting protocol	Package protocol implements the Ticket Granting protocol
types Package types implements all the types used by the TicketGranting protocol	Package types implements all the types used by the TicketGranting protocol
utility Package protocol implements the Utility protocol	Package protocol implements the Utility protocol
types Package types implements all the types used by the Utility protocol	Package types implements all the types used by the Utility protocol