falloutBot/go-mc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documents for /server

Browse Source
This commit is contained in:
Tnze
2021-12-15 15:07:39 +08:00
parent f7bdf676cc
commit 1aebedb5b0
9 changed files with 82 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
examples/frameworkServer/main.go
View File

@ -20,7 +20,6 @@ type MyServer struct {
playerList *server.PlayerList
}
const ServerName = "MyServer"
const MaxPlayer = 20
const IconPath = "./server-icon.png"
@ -28,7 +27,7 @@ var motd = chat.Message{Text: "A Minecraft Server ", Extra: []chat.Message{{Text
func main() {
playerList := server.NewPlayerList(MaxPlayer)
serverInfo, err := server.NewPingInfo(playerList, ServerName, server.ProtocolVersion, motd, readIcon())
serverInfo, err := server.NewPingInfo(playerList, server.ProtocolName, server.ProtocolVersion, motd, readIcon())
if err != nil {
log.Fatalf("Set server info error: %v", err)
}

2
save/chunk_test.go
View File

@ -27,7 +27,7 @@ func TestColumn(t *testing.T) {
}
func BenchmarkColumn_Load(b *testing.B) {
// Test how many time we load a chunk
// Test how many times we load a chunk
var c Column
r, err := region.Open("testdata/region/r.-1.-1.mca")
if err != nil {

4
save/palette.go
View File

@ -13,8 +13,8 @@ type BlockState interface {
type palette interface {
id(v BlockState) int
value(i int) BlockState
io.ReaderFrom
io.WriterTo
pk.FieldEncoder
pk.FieldDecoder
read(r nbt.DecoderReader) (int, error)
}

2
server/auth/auth.go
View File

@ -59,7 +59,7 @@ func Encrypt(conn *net.Conn, name string) (*Resp, error) {
return nil, err
}
//confirm the verify token
//confirm to verify token
if !bytes.Equal(VT1, VT2) {
return nil, errors.New("verify token not match")
}

4
server/gameplay.go
View File

@ -6,5 +6,9 @@ import (
)
type GamePlay interface {
// AcceptPlayer handle everything after "LoginSuccess" is sent.
//
// Note: the connection will be closed after this function returned.
// You don't need to close the connection, but to keep not returning while the player is playing.
AcceptPlayer(name string, id uuid.UUID, protocol int32, conn *net.Conn)
}

64
server/login.go
View File

@ -3,23 +3,49 @@ package server
import (
"fmt"
"github.com/google/uuid"
"github.com/Tnze/go-mc/chat"
"github.com/Tnze/go-mc/data/packetid"
"github.com/Tnze/go-mc/net"
pk "github.com/Tnze/go-mc/net/packet"
"github.com/Tnze/go-mc/offline"
"github.com/Tnze/go-mc/server/auth"
"github.com/google/uuid"
)
// LoginHandler is used to handle player login process, that is,
// from clientbound "LoginStart" packet to serverbound "LoginSuccess" packet.
type LoginHandler interface {
AcceptLogin(conn *net.Conn, protocol int32) (name string, id uuid.UUID, err error)
}
type MojangLoginHandler struct {
OnlineMode bool
Threshold int
// LoginChecker is the interface to check if a player is allowed to log in the server.
// The checking could be anything, server player number, blacklist or whitelist.
// If a player is not allowed to, the reason should be returned and will be sent to client by "LoginDisconnect" packet.
type LoginChecker interface {
CheckPlayer(name string, id uuid.UUID) (ok bool, reason chat.Message)
}
// MojangLoginHandler is a standard LoginHandler that implement both online and offline login progress.
// This implementation also support custom LoginChecker.
// None of Custom login packet (also called LoginPluginRequest/Response) is support by this implementation.
// To do that, implement your own LoginHandler imitate this code.
type MojangLoginHandler struct {
// OnlineMode enables to check player's account.
// And also encrypt the connection after login.
OnlineMode bool
// Threshold set the smallest size of raw network payload to compress.
// Set to 0 to compress all packets. Set to -1 to disable compression.
Threshold int
// LoginChecker is used to apply some checks before sending "LoginSuccess" packet
// (e.g. blacklist or is server full).
// This is optional field and can be set to nil.
LoginChecker
}
// AcceptLogin implement LoginHandler for MojangLoginHandler
func (d *MojangLoginHandler) AcceptLogin(conn *net.Conn, protocol int32) (name string, id uuid.UUID, err error) {
//login start
var p pk.Packet
@ -55,7 +81,8 @@ func (d *MojangLoginHandler) AcceptLogin(conn *net.Conn, protocol int32) (name s
//set compression
if d.Threshold >= 0 {
err = conn.WritePacket(pk.Marshal(
packetid.SetCompression, pk.VarInt(d.Threshold),
packetid.SetCompression,
pk.VarInt(d.Threshold),
))
if err != nil {
return
@ -63,8 +90,25 @@ func (d *MojangLoginHandler) AcceptLogin(conn *net.Conn, protocol int32) (name s
conn.SetThreshold(d.Threshold)
}
// check if player can join (whitelist, blacklist, server full or something else)
if d.LoginChecker != nil {
if ok, result := d.CheckPlayer(name, id); !ok {
// player is not allowed to join the server
err = conn.WritePacket(pk.Marshal(
packetid.LoginDisconnect,
result,
))
if err != nil {
return
}
err = loginFailErr{reason: result}
return
}
}
// send login success
err = conn.WritePacket(pk.Marshal(packetid.LoginSuccess,
err = conn.WritePacket(pk.Marshal(
packetid.LoginSuccess,
pk.UUID(id),
pk.String(name),
))
@ -78,3 +122,11 @@ type wrongPacketErr struct {
func (w wrongPacketErr) Error() string {
return fmt.Sprintf("wrong packet id: expect %#02X, get %#02X", w.expect, w.get)
}
type loginFailErr struct {
reason chat.Message
}
func (l loginFailErr) Error() string {
return "login error: " + l.reason.ClearString()
}

10
server/ping.go
View File

@ -14,14 +14,24 @@ import (
"strings"
)
// ListPingHandler collect server running status info
// which is used to handle client ping and list progress.
type ListPingHandler interface {
// Name of the server version
Name() string
// Protocol number
Protocol() int
MaxPlayer() int
OnlinePlayer() int
// PlayerSamples is a short list of some player in the server
PlayerSamples() []PlayerSample
Description() *chat.Message
// FavIcon should be a PNG image that is Base64 encoded
// (without newlines: \n, new lines no longer work since 1.13)
// and prepended with "data:image/png;base64,".
//
// This method can return empty string if no icon is set.
FavIcon() string
}

36
server/ping_test.go
View File

@ -1,36 +0,0 @@
package server
import (
"github.com/Tnze/go-mc/chat"
"image"
"os"
)
func ExamplePingInfo_standardUsage() {
// Read server icon
f, err := os.Open("./server-icon.png")
if err != nil {
panic(err)
}
defer f.Close()
icon, _, err := image.Decode(f)
if err != nil {
panic(err)
}
// Set server info
playerList := NewPlayerList(20)
pingInfo, err := NewPingInfo(playerList, "1.18", 757, chat.Text("A Minecraft Server"), icon)
if err != nil {
panic(err)
}
// Start listening
s := Server{
ListPingHandler: pingInfo,
LoginHandler: nil,
GamePlay: nil,
}
err = s.Listen("0.0.0.0:25565")
if err != nil {
return
}
}

9
server/server.go
View File

@ -2,16 +2,16 @@
// You can build the server you want by combining the various functional modules provided here.
// An example can be found in examples/frameworkServer.
//
// A server is roughly divided into two parts:
// A server is roughly divided into two parts: Gate and GamePlay
//
// +-----------------------------------------------------------------+
// | Go-MC Server Framework |
// +--------------------------------------+--------------------------+
// | Gate | GamePlay |
// +--------------------+-----------------+ |
// | LoginHandler | ListPingHandler | |
// +--------------------+--------+--------+-----------+--------------+
// | MojangLoginHandler | Info | PlayerList | Others.... |
// | LoginHandler | ListPingHandler | |
// +--------------------+--------+--------+-----------+--------------+
// | MojangLoginHandler | Info | PlayerList | Others.... |
// +--------------------+--------+--------------------+--------------+
//
// Gate, which is used to respond to the client login request, provide login verification,
@ -26,6 +26,7 @@ package server
import "github.com/Tnze/go-mc/net"
const ProtocolName = "1.18.1"
const ProtocolVersion = 757
type Server struct {