From f1d10b7ff8660436c064ccc01b25b2b067ecf3e4 Mon Sep 17 00:00:00 2001 From: Martin Michelsen Date: Tue, 24 May 2022 16:32:15 -0700 Subject: [PATCH] update some documentation --- README.md | 14 ++++++++------ system/blueburst/keys/tfs1.nsk | Bin 0 -> 4169 bytes system/config.example.json | 12 +++++++----- 3 files changed, 15 insertions(+), 11 deletions(-) create mode 100755 system/blueburst/keys/tfs1.nsk diff --git a/README.md b/README.md index ebfe2fc8..d4be9d1c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ newserv is a game server and proxy for Phantasy Star Online (PSO). This project includes code that was reverse-engineered by the community in ages long past, and has been included in many projects since then. It also includes some game data from Phantasy Star Online itself; this data was originally created by Sega. -This project is a rewrite of a rewrite of a game server that I wrote many years ago. So far, it works well with PSO GC Episodes 1 & 2, and lobbies (but not games) are implemented on Episode 3. Some basic functionality works on PSO PC and PSO BB, but there are probably still some cases that lead to errors (which will disconnect the client). +This project is a rewrite of a rewrite of a game server that I wrote many years ago. So far, it works well with PSO GC Episodes 1 & 2, and lobbies (but not games) are implemented on Episode 3. Some basic functionality works on PSO PC and PSO BB, but there are probably still some cases that lead to errors (which will disconnect the client). The proxy works well with PSO GC and PSO BB. Feel free to submit GitHub issues if you find bugs or have feature requests. I'd like to make the server as stable and complete as possible, but I can't promise that I'll respond to issues in a timely manner. @@ -24,12 +24,14 @@ Currently this code should build on macOS and Ubuntu. It will likely work on oth There is a probably-not-too-old macOS release on the newserv GitHub repository (look in the right sidebar). If you're running Linux or want to build newserv yourself, here's what you do: -- Make sure you have CMake and libevent installed. (`brew install cmake libevent` on macOS, `sudo apt-get install cmake libevent-dev` on most Linuxes) +1. Make sure you have CMake and libevent installed. (`brew install cmake libevent` on macOS, `sudo apt-get install cmake libevent-dev` on most Linuxes) - Build and install phosg (https://github.com/fuzziqersoftware/phosg). -- Run `cmake . && make` on the newserv directory. -- In the system/ directory, make a copy of config.example.json named config.json, and edit it appropriately. -- Run `./newserv` in the newserv directory. This will start the game server and run the interactive shell. You may need `sudo` if newserv's built-in DNS server is enabled. -- Use the interactive shell to add a license. Run `help` in the shell to see how to do this. +2. Run `cmake . && make` on the newserv directory. + +After building newserv or downloading a release, do this to set it up and use it: +1. In the system/ directory, make a copy of config.example.json named config.json, and edit it appropriately. +2. Run `./newserv` in the newserv directory. This will start the game server and run the interactive shell. You may need `sudo` if newserv's built-in DNS server is enabled. +3. Use the interactive shell to add a license. Run `help` in the shell to see how to do this. ### Installing quests diff --git a/system/blueburst/keys/tfs1.nsk b/system/blueburst/keys/tfs1.nsk new file mode 100755 index 0000000000000000000000000000000000000000..de83d6ee3b0b434ce84b8538c90a1482aa43ed04 GIT binary patch literal 4169 zcmV-P5Vr4i3zI-%B300M@9RTNTrzVR7~F4>)s-l1db!#i#=7 z(0!RDqtnxLvS8(7F67M#-gyfg)_%`-9XDb*9So?#O10`7_rDX+Jl>z31cmtYy|sgCILz22&*Pm=Eu&(9s%Lr%9J$U3pyho%N8GoZU1g8qEs>Xq>z zXA7R=v=uKZ^mO(g+2kOf?^+gLB|Z=K?(Qkz<j!D#52Z%D zQ)!&!O}l7d_Z4<^4m^2+LpmAru>agg&wIIf(LqI5EseN}p*qn5_{4ba^cGE@$}wnh z2exSj&Ga8Q=Q~5&2$`n!0UmR%b8KX%qdbEv_mSt{-CY_?tIbZiteiS)T}qwF9K5ar zeJBI3*S6PpE)bMJiP@`}`nS?g^XEZ`C7<$`0Fc?30jMV&*;clIfCMwTeU?hEn?t~2 zVtF%g3y?{V{n=VO+;L39(Fjm9fDRJzq#e|$PwnurEjeG>k~j-0Wh1c11M+7PY(4gh zbQNHMBfXn{*&pH5A~swn;zFmekYvy?XBp3R+%KHBwEkxY#ky{w(M&S$_>1$4*0CW@ zhs}{YSPe#`_zfyIi8%Al^)LDm!U=^|*QtVVvgoC-ZNKP#lt71hoSzt7-IWitHQia4gvOhY6Atz@Rwq3<8y|;sM zU^0nXgN+t+8F9%ijdhK|MDz5wJZAG2huuh?xlXWqf0IdULQCC}OPWl8RqyZB>gRF- z_N0dz^~*DP_FS|GMzl(a+|>y99c2jOVa7*BPjC|xaAepX6hB|T*Qmme7E7Z|f-Rd6 zDSdc^E7r5GO2Igb&>1F+$BiNkc|)O=vJI0hgW9hU@ZOkY8?y?PMW_-#m<8LBeHRIA zAM>q}i|)wH7OcECq=c?cXX=xhmOZMzNGpB!TXTwX+v?$Os)7)rVnSf?3_eR+gE17; z;{pHJTBQQfJ2{8xmUs)fEbhyWqG^WJdmOI0(ntUh>m-2UVbbMqLsrfUY@J z%PInVjpoHcIu?37@$TPdfp`?wUODu*4cYM4d z2ljVnZR4%1QBVI_M~ILTb$xX;%~}Z@v|*W78V5=9wJL6Fz9|R>6RfBvC}fE}nGE16 z$>ex%zI9dXMcuIgi{-1w?a6@zs9p;<|9ge!Lf8DA&>qcD>;iccTm2Z_z!xSw&JfGe z;cNv8(GqPwb#!UmYJ6q<`>VWC!3td&bqp<$P+MXae*PpFYOeYnV1NUOfo2Ta(6@1N z=f(>owx9XkXBP%CsSM={q>#>mQpP+Hf1Pb3a;eI|mtv23Px5UpMPZ~X>tH|1>w4nH z^S|83<~kGaZ_($#`p0U6wQY6yS8_`$MnUsBa0)|cXHOz9C#(n)PnWP2n!!W!-84Z5c=7phm-7FZuowRMfse`q6aL@o3UM{(R_OY z1iJ>~n{gNUMwL^T1eKGWIrA`|f_rVEF>*d+wCu6kXC0SU;Wv=Xj;VN-oF%l_56p!` zWdNnRCL%Ig1?SYvgaSnX!3*@kSIPrm!Jcgx4OK)qRg z+x8!omQq-R*2FbRQ*FKwoz8pXO;D!*+u2ZSufl)YXiX;REw&@eb*VoH0PccYJY0&s z2Oi(l_}^5!auA0O^8#z!IL-CG=SF8<^dm+>_@rLLmUpx zGTd329E@oDK2D`eO|H^dX#u^gxd&4DKL)F|FD9?84-!vr64v<-F`VmFM4?B)7%**o}x4jm^ zIM7UIFJ-!a><3#y>RZq*)HBwEKV29tOp)cGz`Rlp(xB# z$73rkbku-p7#&s_i?U4$xx%3a{7OIsoek(c#HU+vyijV2)z&h4r$-9Mn)Ojxg&Q$P zzN5mQXHh!H4WOZi)NaVScEKZUG3)GK>+i{5X^ZPRKdS$b0yuOn4|FA(;5Bz|=zb&E z02FU?zu|$alb?t00j}if8Jq(+6As6G&ayAb3!{r% zpP4|DySJq2S0Le3?2^g@&FB<&>vU=Gpk+tYgOI;?n+W5o>0hn#0G=U|m8rWd!SF_|?ZMaXbGL ztB6JYf%O*mu>i(KJ~Jt-tqgdmKHpAlV=qJuoQ=7G+-!~B$p{$As>@-kT*4A^Ab17p z0j;&0m{E)C_QG1(83lXMi;I}p9hk#HK;+k@K8rG9vyCjLr2%1zBnJR~_0s<-@9Iys zC7ljcL;{HMhx5N+ICApI^|lM zzUa0V=x9394vqhlO)P|Fh^sm>ss-JZ>ATPMoT0R@6+pF)4OXh~6#EO-5@Qod9*@PE zrB114ve6z#pa5b$B4;e3{Z)t&KI5MjseJ3FsY3bvm%<*xjz-T;lobErV~%DP7SqIN(Wg` zGV*=ek&#GNH5orb)u)$G(2%IVrf&YCoN*c{i?aPSm05amYSIibCp%HS_ucT{u9_kY z=^n>d2Ns&g;LAM$kC2!1UnO^z52UB|=};*R&n8VPV4*$ul>ZXJR7cQ^iW%UY<^rz9 z@zgi~rQu;!CWzf>GSN9qCk1GxlAdM$^>1#B;lLnV!8A19+L2f=Vt(B+lU4L50W^0O zx{M{?%nnUIc5hAhs65GY&upTrMvto~e8C6ovs_$Gtc;q8r`Fw6Gevz#ss-Q+yW_M< z>(h|he1F1wcl^%^3~1xAsP}0sgSrk^-41Mi6e_My-zI?IJ@WhYK2E44vdb_qV4Mfx z`uu+t<33+-Q6m|i5O^sHM;|wimr^8m%I?7+jOt)w_IR$b3q=Vs{}Y5r@nDXcAhxvt zYOp)pqwp6n{m141q$1)6Jz0%Pd8k^i;>m@T&+q6p;3oha*RnR0uE|1QSc@>j>j6`U zsf8xm0)fO%2bt)x98@-EDE~#wFCboy7JP#ZzasJjF`blw_}xrg?$;`iJh?v@1a0ST zVDmpjN&U(2Z6suPpeW>ey)nR6zJ(gtXT*IOsbsbEh(|dfzB8RGD3YP0bWuyAN^4PK zN5`nS7v9%HHk`^uSPd;Kh9^sRw=UAD-kh^nZC??@+9hLq0p}dd*DaEA8_fijd2ak> zTXW+Ay3pCLzG{Kv2>tEI3CdGz`Nd`6pwvqwruW*{N66_K&xLJneO$>?Ph?c3NNg;XepHVxW zs$4(UT5TPI2TKe7XRGv7&O(gS1}Le2gDQ64UJ6rp3>&E~LY;8 z>&|@=BI1%8dm*NS-GQ$Bno0q%iTTa?rG1_*f=xRi5UvhnMiq9$*mgLClU)>#=yKm3DO6lTu=xBuiqivJY8-nuUF+Zgh9{g)s z?A5_y<2I~<6w;Sgb4EsqI7@ayL6MJHdAOQoH)90}5b!A}j=m=1v3}hEbBRRL+%NX2 zPGXEWLy!WM3SKB$c0pK#6XFeTisIbQ1>s1xQXsE1DP>>K>6lV2mejc4LV3qU1|n^>`PC*IkKQA20{X~;UA;w&54Li`FLXv_<|0RAB zC=u5^60zyK-xhfw=oJbWfcpIxK|LX@oS{vhhb@z(d7yRA>k}$*UMJqlCr$u8D=IRk_pw)y1>9$ zP9z)c7UaTCOSH1NH2Qq93UIFJ9#1od9%(1*7By=zORFITu<5tyJEG~_rg(|()3*7 TH_6CQPCX5BOP`8me9YYggmV;! literal 0 HcmV?d00001 diff --git a/system/config.example.json b/system/config.example.json index e8a78ca6..e8193cc0 100644 --- a/system/config.example.json +++ b/system/config.example.json @@ -40,7 +40,9 @@ // Ephinea PSOBB uses these ports. Note that 13000 is also used by Schthack // PSOBB, but not for the patch server; this means you unfortunately can't - // support both Schthack and Ephinea PSOBB clients at the same time. + // support both Schthack and Ephinea PSOBB clients at the same time. This + // may be fixed in the future using a similar technique as the + // split_reconnect behavior, but this isn't implemented yet. // "bb-patch3": [13000, "patch", "patch_server"], // "bb-init3": [14000, "bb", "data_server_bb"], @@ -86,10 +88,10 @@ // "RunInteractiveShell": false, // By default, the server only allows users who are registered in the license - // file to connect. By enabling this option, all users will be allowed to - // connect. This option has no effect for Blue Burst clients; they are always - // required to be registered before connecting. Keep in mind that unregistered - // users cannot be banned! + // file to connect. By enabling this option, all non-BB users will be allowed + // to connect. This option has no effect for Blue Burst clients; they are + // always required to be registered before connecting. Keep in mind that + // unregistered users cannot be banned! "AllowUnregisteredUsers": false, // User to run the server as. If present, newserv will attempt to switch to