-
Notifications
You must be signed in to change notification settings - Fork 0
/
atom.xml
6019 lines (5943 loc) · 629 KB
/
atom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
<title>st-little's blog</title>
<subtitle>フリーランスとして活動しているフロントエンドエンジニアのブログサイトです。主にゲームなどの趣味に関することを書いています。</subtitle>
<link href="https://site.little-method.com/atom.xml" rel="self" type="application/atom+xml"/>
<link href="https://site.little-method.com"/>
<generator uri="https://www.getzola.org/">Zola</generator>
<updated>2024-09-16T00:00:00+00:00</updated>
<id>https://site.little-method.com/atom.xml</id>
<entry xml:lang="en">
<title>Rust プラグインに構成を設定する</title>
<published>2024-09-16T00:00:00+00:00</published>
<updated>2024-09-16T00:00:00+00:00</updated>
<author>
<name>Unknown</name>
</author>
<link rel="alternate" href="https://site.little-method.com/blog/set-up-configuration-for-rust-plugin/" type="text/html"/>
<id>https://site.little-method.com/blog/set-up-configuration-for-rust-plugin/</id>
<content type="html"><h1 id="gai-yao">概要</h1>
<p>Rust プラグインに構成を設定し JSON ファイルから設定を読み込みます。</p>
<h1 id="can-kao-qing-bao">参考情報</h1>
<ul>
<li><a href="https://umod.org/guides/architecture/plugin-lifecycle">Plugin lifecycle</a></li>
<li><a href="https://docs.oxidemod.com/guides/developers/my-first-plugin#step-6-implementing-configuration">Step 6: Implementing Configuration</a></li>
</ul>
<h1 id="guan-lian-qing-bao">関連情報</h1>
<ul>
<li><a href="/blog/setup-server-for-rust/">Rust のサーバーを構築する</a></li>
<li><a href="/blog/build-development-environment-for-rust-mods-with-vscode/">VSCode に Rust の Mod の開発環境を構築する</a></li>
<li><a href="/blog/how-to-implement-chat-commands-in-rust-plugin/">Rust プラグインのチャットコマンドを実装する</a></li>
</ul>
<h1 id="quan-xian-noshe-ding">権限の設定</h1>
<p><a href="/blog/how-to-implement-chat-commands-in-rust-plugin/">Rust プラグインのチャットコマンドを実装する</a> で作成した <code>ActivePlayers.cs</code> ファイルに構成を設定します。</p>
<ol>
<li>
<p>ファイルの先頭に名前空間への参照を追加します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">using </span><span>Newtonsoft.Json;
</span></code></pre>
</li>
<li>
<p>configuration class を定義し構成クラスへの参照となるフィールドを定義します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">private </span><span>Configuration </span><span style="color:#bf616a;">_configuration</span><span>;
</span><span>
</span><span style="color:#b48ead;">private class </span><span style="color:#ebcb8b;">Configuration
</span><span style="color:#eff1f5;">{
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">public string </span><span style="color:#bf616a;">ActivePlayerNameMessage</span><span style="color:#eff1f5;">;
</span><span style="color:#eff1f5;">}
</span></code></pre>
</li>
<li>
<p>デフォルトの設定値を使用して新しいプラグイン設定を作成します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">private </span><span>Configuration </span><span style="color:#8fa1b3;">GetDefaultConfig</span><span>()
</span><span>{
</span><span> </span><span style="color:#b48ead;">return </span><span>new Configuration
</span><span> {
</span><span> </span><span style="color:#bf616a;">ActivePlayerNameMessage </span><span>= &quot;</span><span style="color:#a3be8c;">Active Player: </span><span style="color:#d08770;">{0}</span><span>&quot;
</span><span> };
</span><span>}
</span></code></pre>
</li>
<li>
<p>既存のプラグイン設定ファイルをロードします。設定ファイルが見つからない場合は、 LoadDefaultConfig メソッドを呼び出して作成します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">protected </span><span>override </span><span style="color:#bf616a;">void LoadConfig</span><span>(</span><span style="background-color:#bf616a;color:#2b303b;">)</span><span>
</span><span>{
</span><span> </span><span style="color:#bf616a;">base</span><span>.</span><span style="color:#bf616a;">LoadConfig</span><span>();
</span><span>
</span><span> </span><span style="color:#b48ead;">try
</span><span> {
</span><span> </span><span style="color:#bf616a;">_configuration </span><span>= </span><span style="color:#bf616a;">Config</span><span>.</span><span style="color:#bf616a;">ReadObject</span><span>&lt;Configuration&gt;();
</span><span>
</span><span> </span><span style="color:#b48ead;">if </span><span>(</span><span style="color:#bf616a;">_configuration </span><span>== </span><span style="color:#d08770;">null</span><span>)
</span><span> </span><span style="color:#bf616a;">LoadDefaultConfig</span><span>();
</span><span> }
</span><span> </span><span style="color:#b48ead;">catch
</span><span> {
</span><span> </span><span style="color:#bf616a;">PrintError</span><span>(&quot;</span><span style="color:#a3be8c;">Configuration file is corrupt! Check your config file at https://jsonlint.com/</span><span>&quot;);
</span><span> </span><span style="color:#bf616a;">LoadDefaultConfig</span><span>();
</span><span> </span><span style="color:#b48ead;">return</span><span>;
</span><span> }
</span><span>
</span><span> </span><span style="color:#bf616a;">SaveConfig</span><span>();
</span><span>}
</span><span>
</span><span style="color:#b48ead;">protected </span><span>override </span><span style="color:#bf616a;">void LoadDefaultConfig</span><span>(</span><span style="background-color:#bf616a;color:#2b303b;">)</span><span> =&gt; </span><span style="color:#bf616a;">_configuration </span><span>= </span><span style="color:#bf616a;">GetDefaultConfig</span><span>();
</span></code></pre>
</li>
<li>
<p>プラグインの設定を oxide/config ディレクトリの JSON ファイルに書き込みます。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">protected </span><span>override </span><span style="color:#bf616a;">void SaveConfig</span><span>(</span><span style="background-color:#bf616a;color:#2b303b;">)</span><span> =&gt; </span><span style="color:#bf616a;">Config</span><span>.</span><span style="color:#bf616a;">WriteObject</span><span>(</span><span style="color:#bf616a;">_configuration</span><span>);
</span></code></pre>
</li>
<li>
<p>チャットコマンドを実行して表示するメッセージを設定ファイルから取得します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#bf616a;">PrintToChat</span><span>(</span><span style="color:#bf616a;">player</span><span>, </span><span style="color:#b48ead;">string</span><span>.</span><span style="color:#bf616a;">Format</span><span>(</span><span style="color:#bf616a;">_configuration</span><span>.</span><span style="color:#bf616a;">ActivePlayerNameMessage</span><span>, </span><span style="color:#bf616a;">activePlayer</span><span>.</span><span style="color:#bf616a;">displayName</span><span>));
</span></code></pre>
</li>
<li>
<p>全てのソースコードは次の通りです。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">using </span><span>Newtonsoft.Json;
</span><span>
</span><span style="color:#b48ead;">namespace </span><span>Oxide.Plugins
</span><span>{
</span><span> [</span><span style="color:#bf616a;">Info</span><span>(&quot;</span><span style="color:#a3be8c;">Active Players</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">Unknown Author</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">0.1.0</span><span>&quot;)]
</span><span> [</span><span style="color:#bf616a;">Description</span><span>(&quot;</span><span style="color:#a3be8c;">This plugin displays all active usernames in the chat.</span><span>&quot;)]
</span><span> </span><span style="color:#b48ead;">class </span><span style="color:#ebcb8b;">ActivePlayers </span><span style="color:#eff1f5;">: </span><span style="color:#a3be8c;">RustPlugin
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">private </span><span style="color:#eff1f5;">Configuration </span><span style="color:#bf616a;">_configuration</span><span style="color:#eff1f5;">;
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">private class </span><span style="color:#ebcb8b;">Configuration
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">public string </span><span style="color:#bf616a;">ActivePlayerNameMessage</span><span style="color:#eff1f5;">;
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">private </span><span style="color:#eff1f5;">Configuration </span><span style="color:#8fa1b3;">GetDefaultConfig</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">return </span><span>new </span><span style="color:#eff1f5;">Configuration
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">ActivePlayerNameMessage </span><span>= &quot;</span><span style="color:#a3be8c;">Active Player: </span><span style="color:#d08770;">{0}</span><span>&quot;
</span><span style="color:#eff1f5;"> };
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">protected override void </span><span style="color:#8fa1b3;">LoadConfig</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">base</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">LoadConfig</span><span style="color:#eff1f5;">();
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">try
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">_configuration </span><span>= </span><span style="color:#bf616a;">Config</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">ReadObject</span><span style="color:#eff1f5;">&lt;Configuration&gt;();
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">if </span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">_configuration </span><span>== </span><span style="color:#d08770;">null</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">LoadDefaultConfig</span><span style="color:#eff1f5;">();
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">catch
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">PrintError</span><span style="color:#eff1f5;">(</span><span>&quot;</span><span style="color:#a3be8c;">Configuration file is corrupt! Check your config file at https://jsonlint.com/</span><span>&quot;</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">LoadDefaultConfig</span><span style="color:#eff1f5;">();
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">return</span><span style="color:#eff1f5;">;
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">SaveConfig</span><span style="color:#eff1f5;">();
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">protected override void </span><span style="color:#8fa1b3;">LoadDefaultConfig</span><span style="color:#eff1f5;">() </span><span style="color:#b48ead;">=&gt; </span><span style="color:#bf616a;">_configuration </span><span>= </span><span style="color:#bf616a;">GetDefaultConfig</span><span style="color:#eff1f5;">();
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">protected override void </span><span style="color:#8fa1b3;">SaveConfig</span><span style="color:#eff1f5;">() </span><span style="color:#b48ead;">=&gt; </span><span style="color:#bf616a;">Config</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">WriteObject</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">_configuration</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">Init</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> [</span><span style="color:#bf616a;">ChatCommand</span><span style="color:#eff1f5;">(</span><span>&quot;</span><span style="color:#a3be8c;">activeplayers</span><span>&quot;</span><span style="color:#eff1f5;">)]
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">ActivePlayersCommand</span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">command</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">[] </span><span style="color:#bf616a;">args</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">foreach </span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">activePlayer </span><span style="color:#b48ead;">in </span><span style="color:#bf616a;">BasePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">activePlayerList</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">PrintToChat</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Format</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">_configuration</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">ActivePlayerNameMessage</span><span style="color:#eff1f5;">, </span><span style="color:#bf616a;">activePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">displayName</span><span style="color:#eff1f5;">));
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span>}
</span></code></pre>
</li>
</ol>
</content>
</entry>
<entry xml:lang="en">
<title>Rust プラグインの基本的な GUI を実装する</title>
<published>2024-09-01T00:00:00+00:00</published>
<updated>2024-09-01T00:00:00+00:00</updated>
<author>
<name>Unknown</name>
</author>
<link rel="alternate" href="https://site.little-method.com/blog/implement-a-basic-gui-for-the-rust-plugin/" type="text/html"/>
<id>https://site.little-method.com/blog/implement-a-basic-gui-for-the-rust-plugin/</id>
<content type="html"><h1 id="gai-yao">概要</h1>
<p>Rust プラグインの基本的な GUI を実装し、チャットコマンドを実行すると文字を表示します。</p>
<h1 id="can-kao-qing-bao">参考情報</h1>
<ul>
<li><a href="https://umod.org/index.php/guides/rust/basic-concepts-of-gui">Basic concepts of GUI</a></li>
<li><a href="https://github.com/OxideMod/Oxide.Rust/blob/develop/src/RustCui.cs">RustCui</a></li>
<li><a href="https://github.com/Kulltero/Rust.Community/tree/Docs?tab=readme-ov-file">Kulltero/Rust.Community</a></li>
<li><a href="https://umod.org/documentation/api/timers">Timers</a></li>
<li><a href="https://flamingmojo.wordpress.com/">FlamingMojo's Blog</a></li>
</ul>
<h1 id="guan-lian-qing-bao">関連情報</h1>
<ul>
<li><a href="/blog/how-to-implement-chat-commands-in-rust-plugin/">Rust プラグインのチャットコマンドを実装する</a></li>
</ul>
<h1 id="huan-jing">環境</h1>
<ul>
<li>Visual Studio Code 1.91.1</li>
<li>Docker Desktop 4.33.1</li>
<li>.NETFramework Standard 2.1</li>
<li>Microsoft.NETFramework.ReferenceAssemblies 1.0.3</li>
<li>OpenMod.Rust.Oxide 3.8.10</li>
</ul>
<h1 id="gui-noshi-zhuang">GUI の実装</h1>
<p>チャットコマンド <code>gui</code> を実行すると <code>Hello World!</code> を 5 秒間表示するプラグインを実装します。</p>
<ol>
<li>
<p>背景のコンポーネントを実装します。Color は正規化された RGBA で指定します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">var </span><span style="color:#bf616a;">imgComp </span><span>= new CuiImageComponent
</span><span>{
</span><span> </span><span style="color:#bf616a;">Color </span><span>= &quot;</span><span style="color:#a3be8c;">0.753 0.753 0.753 1</span><span>&quot;, </span><span style="color:#65737e;">// silver: #c0c0c0
</span><span> </span><span style="color:#bf616a;">FadeIn </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f
</span><span>};
</span></code></pre>
</li>
<li>
<p>文字のコンポーネントを実装します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">var </span><span style="color:#bf616a;">txtComp </span><span>= new CuiTextComponent
</span><span>{
</span><span> </span><span style="color:#bf616a;">Text </span><span>= &quot;</span><span style="color:#a3be8c;">Hello World!</span><span>&quot;,
</span><span> </span><span style="color:#bf616a;">Color </span><span>= &quot;</span><span style="color:#a3be8c;">0 0 0 1</span><span>&quot;, </span><span style="color:#65737e;">// black: #000000
</span><span> </span><span style="color:#bf616a;">FadeIn </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f</span><span>,
</span><span> </span><span style="color:#bf616a;">Align </span><span>= </span><span style="color:#bf616a;">TextAnchor</span><span>.</span><span style="color:#bf616a;">MiddleCenter</span><span>,
</span><span> </span><span style="color:#bf616a;">FontSize </span><span>= </span><span style="color:#d08770;">24
</span><span>};
</span></code></pre>
</li>
<li>
<p>位置のコンポーネントを実装します。Anchor は幅と高さを 0.0 (0%) から 1.0 (100%) までのパーセント (%) で表す数値です。Min 値はの左下隅の位置で、Max は右上隅の位置です。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">var </span><span style="color:#bf616a;">rectComp </span><span>= new CuiRectTransformComponent
</span><span>{
</span><span> </span><span style="color:#bf616a;">AnchorMin </span><span>= &quot;</span><span style="color:#a3be8c;">0.2 0.8</span><span>&quot;,
</span><span> </span><span style="color:#bf616a;">AnchorMax </span><span>= &quot;</span><span style="color:#a3be8c;">0.8 0.95</span><span>&quot;
</span><span>};
</span></code></pre>
</li>
<li>
<p>背景の要素を実装します。Parent は <a href="https://umod.org/index.php/guides/rust/basic-concepts-of-gui#layers">レイヤー</a> を指定します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">var </span><span style="color:#bf616a;">imgElem </span><span>= new CuiElement
</span><span>{
</span><span> </span><span style="color:#bf616a;">Name </span><span>= &quot;</span><span style="color:#a3be8c;">parentImageElement</span><span>&quot;,
</span><span> </span><span style="color:#bf616a;">Parent </span><span>= &quot;</span><span style="color:#a3be8c;">Hud</span><span>&quot;,
</span><span> </span><span style="color:#bf616a;">FadeOut </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f</span><span>,
</span><span>};
</span><span style="color:#bf616a;">imgElem</span><span>.</span><span style="color:#bf616a;">Components</span><span>.</span><span style="color:#bf616a;">Add</span><span>(</span><span style="color:#bf616a;">imgComp</span><span>);
</span><span style="color:#bf616a;">imgElem</span><span>.</span><span style="color:#bf616a;">Components</span><span>.</span><span style="color:#bf616a;">Add</span><span>(</span><span style="color:#bf616a;">rectComp</span><span>);
</span></code></pre>
</li>
<li>
<p>文字の要素を実装します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">var </span><span style="color:#bf616a;">txtElem </span><span>= new CuiElement
</span><span>{
</span><span> </span><span style="color:#bf616a;">Name </span><span>= &quot;</span><span style="color:#a3be8c;">childTextElement</span><span>&quot;,
</span><span> </span><span style="color:#bf616a;">FadeOut </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f</span><span>,
</span><span>};
</span><span style="color:#bf616a;">txtElem</span><span>.</span><span style="color:#bf616a;">Components</span><span>.</span><span style="color:#bf616a;">Add</span><span>(</span><span style="color:#bf616a;">txtComp</span><span>);
</span><span style="color:#bf616a;">txtElem</span><span>.</span><span style="color:#bf616a;">Components</span><span>.</span><span style="color:#bf616a;">Add</span><span>(</span><span style="color:#bf616a;">rectComp</span><span>);
</span></code></pre>
</li>
<li>
<p><code>CuiElementContainer</code> に要素を追加します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">var </span><span style="color:#bf616a;">elements </span><span>= new CuiElementContainer();
</span><span style="color:#bf616a;">elements</span><span>.</span><span style="color:#bf616a;">Add</span><span>(</span><span style="color:#bf616a;">txtElem</span><span>);
</span><span style="color:#bf616a;">elements</span><span>.</span><span style="color:#bf616a;">Add</span><span>(</span><span style="color:#bf616a;">imgElem</span><span>);
</span></code></pre>
</li>
<li>
<p>実装した GUI をプレイヤーに送信します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#bf616a;">CuiHelper</span><span>.</span><span style="color:#bf616a;">AddUi</span><span>(</span><span style="color:#bf616a;">player</span><span>, </span><span style="color:#bf616a;">elements</span><span>);
</span></code></pre>
</li>
<li>
<p>GUI が 5 秒後に消えるようにタイマーを実装します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#bf616a;">timer</span><span>.</span><span style="color:#bf616a;">Once</span><span>(</span><span style="color:#d08770;">5.0</span><span style="color:#b48ead;">f</span><span>, () </span><span style="color:#b48ead;">=&gt;
</span><span>{
</span><span> </span><span style="color:#bf616a;">CuiHelper</span><span>.</span><span style="color:#bf616a;">DestroyUi</span><span>(</span><span style="color:#bf616a;">player</span><span>, &quot;</span><span style="color:#a3be8c;">parentImageElement</span><span>&quot;);
</span><span> </span><span style="color:#bf616a;">CuiHelper</span><span>.</span><span style="color:#bf616a;">DestroyUi</span><span>(</span><span style="color:#bf616a;">player</span><span>, &quot;</span><span style="color:#a3be8c;">childTextElement</span><span>&quot;);
</span><span>});
</span></code></pre>
</li>
</ol>
<h1 id="quan-tenososukodo">全てのソースコード</h1>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">using </span><span>Oxide.Game.Rust.Cui;
</span><span style="color:#b48ead;">using </span><span>UnityEngine;
</span><span>
</span><span style="color:#b48ead;">namespace </span><span>Oxide.Plugins
</span><span>{
</span><span> [</span><span style="color:#bf616a;">Info</span><span>(&quot;</span><span style="color:#a3be8c;">Basic concepts of GUI</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">Unknown Author</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">0.1.0</span><span>&quot;)]
</span><span> [</span><span style="color:#bf616a;">Description</span><span>(&quot;</span><span style="color:#a3be8c;">Basic GUI concepts such as anchors, offsets, etc.</span><span>&quot;)]
</span><span> </span><span style="color:#b48ead;">class </span><span style="color:#ebcb8b;">BasicConceptsOfGUI </span><span style="color:#eff1f5;">: </span><span style="color:#a3be8c;">RustPlugin
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">Init</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> [</span><span style="color:#bf616a;">ChatCommand</span><span style="color:#eff1f5;">(</span><span>&quot;</span><span style="color:#a3be8c;">gui</span><span>&quot;</span><span style="color:#eff1f5;">)]
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">GUICommand</span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">command</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">[] </span><span style="color:#bf616a;">args</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">var </span><span style="color:#bf616a;">imgComp </span><span>= new </span><span style="color:#eff1f5;">CuiImageComponent
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">Color </span><span>= &quot;</span><span style="color:#a3be8c;">0.753 0.753 0.753 1</span><span>&quot;</span><span style="color:#eff1f5;">, </span><span style="color:#65737e;">// silver: #c0c0c0
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">FadeIn </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f
</span><span style="color:#eff1f5;"> };
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">var </span><span style="color:#bf616a;">txtComp </span><span>= new </span><span style="color:#eff1f5;">CuiTextComponent
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">Text </span><span>= &quot;</span><span style="color:#a3be8c;">Hello World!</span><span>&quot;</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">Color </span><span>= &quot;</span><span style="color:#a3be8c;">0 0 0 1</span><span>&quot;</span><span style="color:#eff1f5;">, </span><span style="color:#65737e;">// black: #000000
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">FadeIn </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">Align </span><span>= </span><span style="color:#bf616a;">TextAnchor</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">MiddleCenter</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">FontSize </span><span>= </span><span style="color:#d08770;">24
</span><span style="color:#eff1f5;"> };
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">var </span><span style="color:#bf616a;">rectComp </span><span>= new </span><span style="color:#eff1f5;">CuiRectTransformComponent
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">AnchorMin </span><span>= &quot;</span><span style="color:#a3be8c;">0.2 0.8</span><span>&quot;</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">AnchorMax </span><span>= &quot;</span><span style="color:#a3be8c;">0.8 0.95</span><span>&quot;
</span><span style="color:#eff1f5;"> };
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">var </span><span style="color:#bf616a;">imgElem </span><span>= new </span><span style="color:#eff1f5;">CuiElement
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">Name </span><span>= &quot;</span><span style="color:#a3be8c;">parentImageElement</span><span>&quot;</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">Parent </span><span>= &quot;</span><span style="color:#a3be8c;">Hud</span><span>&quot;</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">FadeOut </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> };
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">imgElem</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Components</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Add</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">imgComp</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">imgElem</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Components</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Add</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">rectComp</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">var </span><span style="color:#bf616a;">txtElem </span><span>= new </span><span style="color:#eff1f5;">CuiElement
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">Name </span><span>= &quot;</span><span style="color:#a3be8c;">childTextElement</span><span>&quot;</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">FadeOut </span><span>= </span><span style="color:#d08770;">1.0</span><span style="color:#b48ead;">f</span><span style="color:#eff1f5;">,
</span><span style="color:#eff1f5;"> };
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">txtElem</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Components</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Add</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">txtComp</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">txtElem</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Components</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Add</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">rectComp</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">var </span><span style="color:#bf616a;">elements </span><span>= new </span><span style="color:#eff1f5;">CuiElementContainer();
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">elements</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Add</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">txtElem</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">elements</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Add</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">imgElem</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">CuiHelper</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">AddUi</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#bf616a;">elements</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">timer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Once</span><span style="color:#eff1f5;">(</span><span style="color:#d08770;">5.0</span><span style="color:#b48ead;">f</span><span style="color:#eff1f5;">, () </span><span style="color:#b48ead;">=&gt;
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">CuiHelper</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">DestroyUi</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span>&quot;</span><span style="color:#a3be8c;">parentImageElement</span><span>&quot;</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">CuiHelper</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">DestroyUi</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span>&quot;</span><span style="color:#a3be8c;">childTextElement</span><span>&quot;</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> });
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span>}
</span></code></pre>
</content>
</entry>
<entry xml:lang="en">
<title>Rust プラグインをローカライズする</title>
<published>2024-08-15T00:00:00+00:00</published>
<updated>2024-08-15T00:00:00+00:00</updated>
<author>
<name>Unknown</name>
</author>
<link rel="alternate" href="https://site.little-method.com/blog/localize-rust-plugin/" type="text/html"/>
<id>https://site.little-method.com/blog/localize-rust-plugin/</id>
<content type="html"><h1 id="gai-yao">概要</h1>
<p>Rust プラグインをローカライズします。</p>
<h1 id="can-kao-qing-bao">参考情報</h1>
<ul>
<li><a href="https://docs.oxidemod.com/guides/owners/localization">Localization</a></li>
<li><a href="https://umod.org/documentation/api/localization">Localization</a></li>
</ul>
<h1 id="guan-lian-qing-bao">関連情報</h1>
<ul>
<li><a href="/blog/setup-server-for-rust/">Rust のサーバーを構築する</a></li>
<li><a href="/blog/build-development-environment-for-rust-mods-with-vscode/">VSCode に Rust の Mod の開発環境を構築する</a></li>
<li><a href="/blog/how-to-implement-chat-commands-in-rust-plugin/">Rust プラグインのチャットコマンドを実装する</a></li>
</ul>
<h1 id="dehuorutonowen-yan-woshe-ding">デフォルトの文言を設定</h1>
<p><a href="/blog/how-to-implement-chat-commands-in-rust-plugin/">Rust プラグインのチャットコマンドを実装する</a> で作成した <code>ActivePlayers.cs</code> ファイルをローカライズします。</p>
<ol>
<li>
<p><a href="https://learn.microsoft.com/ja-jp/dotnet/api/system.collections.generic.dictionary-2?view=net-8.0">Dictionary</a> を使用するため、<code>System.Collections.Generic</code> をインポートします。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">using </span><span>System.Collections.Generic;
</span></code></pre>
</li>
<li>
<p>LoadDefaultMessages メソッドをオーバーライドして、デフォルトの文言を設定します。言語コードは <a href="https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes">ISO 639 language code</a> を指定します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#65737e;">// English
</span><span> </span><span style="color:#bf616a;">lang</span><span>.</span><span style="color:#bf616a;">RegisterMessages</span><span>(new Dictionary&lt;</span><span style="color:#b48ead;">string</span><span>, </span><span style="color:#b48ead;">string</span><span>&gt;
</span><span> {
</span><span> [&quot;</span><span style="color:#a3be8c;">ActivePlayerName</span><span>&quot;] = &quot;</span><span style="color:#a3be8c;">Active Player: </span><span style="color:#d08770;">{0}</span><span>&quot;
</span><span> }, </span><span style="color:#bf616a;">this</span><span>);
</span><span>
</span><span> </span><span style="color:#65737e;">// Japanese
</span><span> </span><span style="color:#bf616a;">lang</span><span>.</span><span style="color:#bf616a;">RegisterMessages</span><span>(new Dictionary&lt;</span><span style="color:#b48ead;">string</span><span>, </span><span style="color:#b48ead;">string</span><span>&gt;
</span><span> {
</span><span> [&quot;</span><span style="color:#a3be8c;">ActivePlayerName</span><span>&quot;] = &quot;</span><span style="color:#a3be8c;">アクティブプレーヤー: </span><span style="color:#d08770;">{0}</span><span>&quot;
</span><span> }, </span><span style="color:#bf616a;">this</span><span>, &quot;</span><span style="color:#a3be8c;">ja</span><span>&quot;);
</span></code></pre>
</li>
<li>
<p>ActivePlayersCommand メソッドでデフォルトの文言を取得します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">activePlayerNameMessage </span><span>= </span><span style="color:#bf616a;">lang</span><span>.</span><span style="color:#bf616a;">GetMessage</span><span>(&quot;</span><span style="color:#a3be8c;">ActivePlayerName</span><span>&quot;, </span><span style="color:#bf616a;">this</span><span>, </span><span style="color:#bf616a;">player</span><span>.</span><span style="color:#bf616a;">UserIDString</span><span>);
</span></code></pre>
</li>
<li>
<p>デフォルトの文言をチャットに表示します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#b48ead;">foreach </span><span>(BasePlayer </span><span style="color:#bf616a;">activePlayer </span><span style="color:#b48ead;">in </span><span style="color:#bf616a;">BasePlayer</span><span>.</span><span style="color:#bf616a;">activePlayerList</span><span>)
</span><span> {
</span><span> </span><span style="color:#bf616a;">PrintToChat</span><span>(</span><span style="color:#bf616a;">player</span><span>, </span><span style="color:#b48ead;">string</span><span>.</span><span style="color:#bf616a;">Format</span><span>(</span><span style="color:#bf616a;">activePlayerNameMessage</span><span>, </span><span style="color:#bf616a;">activePlayer</span><span>.</span><span style="color:#bf616a;">displayName</span><span>));
</span><span> }
</span></code></pre>
</li>
<li>
<p>全てのソースコードは次の通りです。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">using </span><span>System.Collections.Generic;
</span><span>
</span><span style="color:#b48ead;">namespace </span><span>Oxide.Plugins
</span><span>{
</span><span> [</span><span style="color:#bf616a;">Info</span><span>(&quot;</span><span style="color:#a3be8c;">Active Players</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">Unknown Author</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">0.1.0</span><span>&quot;)]
</span><span> [</span><span style="color:#bf616a;">Description</span><span>(&quot;</span><span style="color:#a3be8c;">This plugin displays all active usernames in the chat.</span><span>&quot;)]
</span><span> </span><span style="color:#b48ead;">class </span><span style="color:#ebcb8b;">ActivePlayers </span><span style="color:#eff1f5;">: </span><span style="color:#a3be8c;">RustPlugin
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">Init</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">protected override void </span><span style="color:#8fa1b3;">LoadDefaultMessages</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#65737e;">// English
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">lang</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">RegisterMessages</span><span style="color:#eff1f5;">(</span><span>new </span><span style="color:#eff1f5;">Dictionary&lt;</span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">&gt;
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> [</span><span>&quot;</span><span style="color:#a3be8c;">ActivePlayerName</span><span>&quot;</span><span style="color:#eff1f5;">] </span><span>= &quot;</span><span style="color:#a3be8c;">Active Player: </span><span style="color:#d08770;">{0}</span><span>&quot;
</span><span style="color:#eff1f5;"> }, </span><span style="color:#bf616a;">this</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#65737e;">// Japanese
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">lang</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">RegisterMessages</span><span style="color:#eff1f5;">(</span><span>new </span><span style="color:#eff1f5;">Dictionary&lt;</span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">&gt;
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> [</span><span>&quot;</span><span style="color:#a3be8c;">ActivePlayerName</span><span>&quot;</span><span style="color:#eff1f5;">] </span><span>= &quot;</span><span style="color:#a3be8c;">アクティブプレーヤー: </span><span style="color:#d08770;">{0}</span><span>&quot;
</span><span style="color:#eff1f5;"> }, </span><span style="color:#bf616a;">this</span><span style="color:#eff1f5;">, </span><span>&quot;</span><span style="color:#a3be8c;">ja</span><span>&quot;</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> [</span><span style="color:#bf616a;">ChatCommand</span><span style="color:#eff1f5;">(</span><span>&quot;</span><span style="color:#a3be8c;">activeplayers</span><span>&quot;</span><span style="color:#eff1f5;">)]
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">ActivePlayersCommand</span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">command</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">[] </span><span style="color:#bf616a;">args</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">activePlayerNameMessage </span><span>= </span><span style="color:#bf616a;">lang</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">GetMessage</span><span style="color:#eff1f5;">(</span><span>&quot;</span><span style="color:#a3be8c;">ActivePlayerName</span><span>&quot;</span><span style="color:#eff1f5;">, </span><span style="color:#bf616a;">this</span><span style="color:#eff1f5;">, </span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">UserIDString</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">foreach </span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">activePlayer </span><span style="color:#b48ead;">in </span><span style="color:#bf616a;">BasePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">activePlayerList</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">PrintToChat</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">Format</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">activePlayerNameMessage</span><span style="color:#eff1f5;">, </span><span style="color:#bf616a;">activePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">displayName</span><span style="color:#eff1f5;">));
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span>}
</span></code></pre>
</li>
</ol>
<h1 id="dehuorutonowen-yan-woshang-shu-ki">デフォルトの文言を上書き</h1>
<p>プラグインの文言をサーバー側で上書きします。</p>
<ol>
<li>
<p>サーバーの <code>oxide/lang/ja</code> にある JSON ファイル <code>ActivePlayers.json</code> を VSCode で開きます。</p>
</li>
<li>
<p><code>ActivePlayerName</code> の文言を書き換えます。</p>
<pre data-lang="json" style="background-color:#2b303b;color:#c0c5ce;" class="language-json "><code class="language-json" data-lang="json"><span>{
</span><span> &quot;</span><span style="color:#a3be8c;">ActivePlayerName</span><span>&quot;: &quot;</span><span style="color:#a3be8c;">現在ログイン中のユーザー: {0}</span><span>&quot;
</span><span>}
</span></code></pre>
</li>
</ol>
<h1 id="puraguinnodong-zuo-que-ren">プラグインの動作確認</h1>
<ol>
<li>
<p><code>ActivePlayers.cs</code> ファイルをサーバーの oxide/plugins フォルダにコピーします。</p>
</li>
<li>
<p>サーバーを起動します。</p>
</li>
<li>
<p>Rust を起動してサーバーに接続します。</p>
</li>
<li>
<p>チャットに <code>/activeplayers</code> を入力します。</p>
</li>
</ol>
</content>
</entry>
<entry xml:lang="en">
<title>Rust プラグインに権限を設定する</title>
<published>2024-08-14T00:00:00+00:00</published>
<updated>2024-08-14T00:00:00+00:00</updated>
<author>
<name>Unknown</name>
</author>
<link rel="alternate" href="https://site.little-method.com/blog/set-permissions-for-the-rust-plugin/" type="text/html"/>
<id>https://site.little-method.com/blog/set-permissions-for-the-rust-plugin/</id>
<content type="html"><h1 id="gai-yao">概要</h1>
<p>Rust プラグインに権限を設定し、権限のあるユーザーのみがプラグインを使用できるようにします。</p>
<h1 id="can-kao-qing-bao">参考情報</h1>
<ul>
<li><a href="https://umod.org/guides/architecture/plugin-lifecycle">Plugin lifecycle</a></li>
<li><a href="https://docs.oxidemod.com/guides/owners/permissions">Introduction to Permissions</a></li>
</ul>
<h1 id="guan-lian-qing-bao">関連情報</h1>
<ul>
<li><a href="/blog/setup-server-for-rust/">Rust のサーバーを構築する</a></li>
<li><a href="/blog/build-development-environment-for-rust-mods-with-vscode/">VSCode に Rust の Mod の開発環境を構築する</a></li>
<li><a href="/blog/how-to-implement-chat-commands-in-rust-plugin/">Rust プラグインのチャットコマンドを実装する</a></li>
</ul>
<h1 id="quan-xian-noshe-ding">権限の設定</h1>
<p><a href="/blog/how-to-implement-chat-commands-in-rust-plugin/">Rust プラグインのチャットコマンドを実装する</a> で作成した <code>ActivePlayers.cs</code> ファイルに権限を設定します。</p>
<ol>
<li>
<p>プロパティ <code>Permission</code> で実装する権限を指定します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#b48ead;">private const string </span><span style="color:#bf616a;">Permission </span><span>= &quot;</span><span style="color:#a3be8c;">activeplayers.allow</span><span>&quot;;
</span></code></pre>
</li>
<li>
<p>Init メソッドで権限を追加します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">Init</span><span>()
</span><span> {
</span><span> </span><span style="color:#bf616a;">permission</span><span>.</span><span style="color:#bf616a;">RegisterPermission</span><span>(</span><span style="color:#bf616a;">Permission</span><span>, </span><span style="color:#bf616a;">this</span><span>);
</span><span> }
</span></code></pre>
</li>
<li>
<p>チャットコマンドを実行する前に権限があるかチェックします。権限がない場合はチャットにメッセージを表示して権限がないことをユーザーに伝えます。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#b48ead;">if </span><span>(!</span><span style="color:#bf616a;">permission</span><span>.</span><span style="color:#bf616a;">UserHasPermission</span><span>(</span><span style="color:#bf616a;">player</span><span>.</span><span style="color:#bf616a;">UserIDString</span><span>, </span><span style="color:#bf616a;">Permission</span><span>))
</span><span> {
</span><span> </span><span style="color:#bf616a;">PrintToChat</span><span>(</span><span style="color:#bf616a;">player</span><span>, &quot;</span><span style="color:#a3be8c;">You don&#39;t have permission to use this command!</span><span>&quot;);
</span><span> </span><span style="color:#b48ead;">return</span><span>;
</span><span> }
</span></code></pre>
</li>
<li>
<p>全てのソースコードは次の通りです。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">namespace </span><span>Oxide.Plugins
</span><span>{
</span><span> [</span><span style="color:#bf616a;">Info</span><span>(&quot;</span><span style="color:#a3be8c;">Active Players</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">Unknown Author</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">0.1.0</span><span>&quot;)]
</span><span> [</span><span style="color:#bf616a;">Description</span><span>(&quot;</span><span style="color:#a3be8c;">This plugin displays all active usernames in the chat.</span><span>&quot;)]
</span><span> </span><span style="color:#b48ead;">class </span><span style="color:#ebcb8b;">ActivePlayers </span><span style="color:#eff1f5;">: </span><span style="color:#a3be8c;">RustPlugin
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">private const string </span><span style="color:#bf616a;">Permission </span><span>= &quot;</span><span style="color:#a3be8c;">activeplayers.allow</span><span>&quot;</span><span style="color:#eff1f5;">;
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">Init</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">permission</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">RegisterPermission</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">Permission</span><span style="color:#eff1f5;">, </span><span style="color:#bf616a;">this</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> [</span><span style="color:#bf616a;">ChatCommand</span><span style="color:#eff1f5;">(</span><span>&quot;</span><span style="color:#a3be8c;">activeplayers</span><span>&quot;</span><span style="color:#eff1f5;">)]
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">ActivePlayersCommand</span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">command</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">[] </span><span style="color:#bf616a;">args</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">if </span><span style="color:#eff1f5;">(</span><span>!</span><span style="color:#bf616a;">permission</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">UserHasPermission</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">UserIDString</span><span style="color:#eff1f5;">, </span><span style="color:#bf616a;">Permission</span><span style="color:#eff1f5;">))
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">PrintToChat</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span>&quot;</span><span style="color:#a3be8c;">You don&#39;t have permission to use this command!</span><span>&quot;</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">return</span><span style="color:#eff1f5;">;
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">foreach </span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">activePlayer </span><span style="color:#b48ead;">in </span><span style="color:#bf616a;">BasePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">activePlayerList</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">PrintToChat</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span>$&quot;</span><span style="color:#a3be8c;">Active Player: </span><span style="color:#eff1f5;">{</span><span style="color:#bf616a;">activePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">displayName</span><span style="color:#eff1f5;">}</span><span>&quot;</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span>}
</span></code></pre>
</li>
</ol>
<h1 id="quan-xian-nodong-zuo-que-ren">権限の動作確認</h1>
<ol>
<li>
<p><code>ActivePlayers.cs</code> ファイルをサーバーの oxide/plugins フォルダにコピーします。</p>
</li>
<li>
<p>サーバーを起動します。</p>
</li>
<li>
<p>Rust を起動してサーバーに接続します。</p>
</li>
<li>
<p>Rust のチャットに <code>/activeplayers</code> を入力すると、権限がないため次のメッセージが表示されます。</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>You don&#39;t have permission to use this command!
</span></code></pre>
</li>
<li>
<p>サーバー側で次のコマンドを実行し権限を付与します。</p>
<pre style="background-color:#2b303b;color:#c0c5ce;"><code><span>oxide.grant user {USER_ID} activeplayers.allow
</span></code></pre>
</li>
<li>
<p>Rust のチャットに <code>/activeplayers</code> を入力すると、権限があるためアクティブユーザーの名前が表示されます。</p>
</li>
</ol>
</content>
</entry>
<entry xml:lang="en">
<title>Rust プラグインのチャットコマンドを実装する</title>
<published>2024-08-13T00:00:00+00:00</published>
<updated>2024-08-13T00:00:00+00:00</updated>
<author>
<name>Unknown</name>
</author>
<link rel="alternate" href="https://site.little-method.com/blog/how-to-implement-chat-commands-in-rust-plugin/" type="text/html"/>
<id>https://site.little-method.com/blog/how-to-implement-chat-commands-in-rust-plugin/</id>
<content type="html"><h1 id="gai-yao">概要</h1>
<p>チャットコマンドを実行しアクティブユーザーの名前をチャットに表示する Rust 用プラグインを作成します。</p>
<h1 id="can-kao-qing-bao">参考情報</h1>
<ul>
<li><a href="https://umod.org/guides/architecture/plugin-lifecycle">Plugin lifecycle</a></li>
<li><a href="https://docs.oxidemod.com/guides/developers/my-first-plugin">Writing your first plugin</a></li>
</ul>
<h1 id="guan-lian-qing-bao">関連情報</h1>
<ul>
<li><a href="/blog/setup-server-for-rust/">Rust のサーバーを構築する</a></li>
<li><a href="/blog/build-development-environment-for-rust-mods-with-vscode/">VSCode に Rust の Mod の開発環境を構築する</a></li>
</ul>
<h1 id="puraguinnoshi-zhuang-fang-fa">プラグインの実装方法</h1>
<p><code>ActivePlayers.cs</code> ファイルを作成し、アクティブユーザーの名前をチャットに表示するチャットコマンドを実装します。</p>
<ol>
<li>
<p>メソッド <code>ActivePlayersCommand</code> を実装します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">ActivePlayersCommand</span><span>(BasePlayer </span><span style="color:#bf616a;">player</span><span>, </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">command</span><span>, </span><span style="color:#b48ead;">string</span><span>[] </span><span style="color:#bf616a;">args</span><span>)
</span><span> {
</span><span>
</span><span> }
</span></code></pre>
<p>メソッドは次の引数を受け取ります。</p>
<ul>
<li>player: コマンドを呼び出したBasePlayer</li>
<li>command: 呼び出されるコマンド</li>
<li>args: コマンドに続くオプションの追加引数の配列</li>
</ul>
</li>
<li>
<p>アノテーション <code>ChatCommand</code> でチャットコマンドを指定します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> [</span><span style="color:#bf616a;">ChatCommand</span><span>(&quot;</span><span style="color:#a3be8c;">activeplayers</span><span>&quot;)]
</span></code></pre>
</li>
<li>
<p><code>BasePlayer.activePlayerList</code> でアクティブユーザーを取得し、その名前を <code>PrintToChat</code> でチャットに出力します。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span> </span><span style="color:#b48ead;">foreach </span><span>(BasePlayer </span><span style="color:#bf616a;">activePlayer </span><span style="color:#b48ead;">in </span><span style="color:#bf616a;">BasePlayer</span><span>.</span><span style="color:#bf616a;">activePlayerList</span><span>)
</span><span> {
</span><span> </span><span style="color:#bf616a;">PrintToChat</span><span>(</span><span style="color:#bf616a;">player</span><span>, $&quot;</span><span style="color:#a3be8c;">Active Player: </span><span>{</span><span style="color:#bf616a;">activePlayer</span><span>.</span><span style="color:#bf616a;">displayName</span><span>}&quot;);
</span><span> }
</span></code></pre>
</li>
<li>
<p>全てのソースコードは次の通りです。</p>
<pre data-lang="cs" style="background-color:#2b303b;color:#c0c5ce;" class="language-cs "><code class="language-cs" data-lang="cs"><span style="color:#b48ead;">namespace </span><span>Oxide.Plugins
</span><span>{
</span><span> [</span><span style="color:#bf616a;">Info</span><span>(&quot;</span><span style="color:#a3be8c;">Active Players</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">Unknown Author</span><span>&quot;, &quot;</span><span style="color:#a3be8c;">0.1.0</span><span>&quot;)]
</span><span> [</span><span style="color:#bf616a;">Description</span><span>(&quot;</span><span style="color:#a3be8c;">This plugin displays all active usernames in the chat.</span><span>&quot;)]
</span><span> </span><span style="color:#b48ead;">class </span><span style="color:#ebcb8b;">ActivePlayers </span><span style="color:#eff1f5;">: </span><span style="color:#a3be8c;">RustPlugin
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">Init</span><span style="color:#eff1f5;">()
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;">
</span><span style="color:#eff1f5;"> [</span><span style="color:#bf616a;">ChatCommand</span><span style="color:#eff1f5;">(</span><span>&quot;</span><span style="color:#a3be8c;">activeplayers</span><span>&quot;</span><span style="color:#eff1f5;">)]
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">void </span><span style="color:#8fa1b3;">ActivePlayersCommand</span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string </span><span style="color:#bf616a;">command</span><span style="color:#eff1f5;">, </span><span style="color:#b48ead;">string</span><span style="color:#eff1f5;">[] </span><span style="color:#bf616a;">args</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#b48ead;">foreach </span><span style="color:#eff1f5;">(BasePlayer </span><span style="color:#bf616a;">activePlayer </span><span style="color:#b48ead;">in </span><span style="color:#bf616a;">BasePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">activePlayerList</span><span style="color:#eff1f5;">)
</span><span style="color:#eff1f5;"> {
</span><span style="color:#eff1f5;"> </span><span style="color:#bf616a;">PrintToChat</span><span style="color:#eff1f5;">(</span><span style="color:#bf616a;">player</span><span style="color:#eff1f5;">, </span><span>$&quot;</span><span style="color:#a3be8c;">Active Player: </span><span style="color:#eff1f5;">{</span><span style="color:#bf616a;">activePlayer</span><span style="color:#eff1f5;">.</span><span style="color:#bf616a;">displayName</span><span style="color:#eff1f5;">}</span><span>&quot;</span><span style="color:#eff1f5;">);
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span style="color:#eff1f5;"> }
</span><span>}
</span></code></pre>
</li>
</ol>
<h1 id="puraguinnodong-zuo-que-ren">プラグインの動作確認</h1>
<ol>
<li>
<p><code>ActivePlayers.cs</code> ファイルをサーバーの oxide/plugins フォルダにコピーします。</p>
</li>
<li>
<p>サーバーを起動します。</p>
</li>
<li>
<p>Rust を起動してサーバーに接続します。</p>
</li>
<li>
<p>チャットに <code>/activeplayers</code> を入力します。</p>
</li>
</ol>
</content>
</entry>
<entry xml:lang="en">
<title>Terraria のサーバーを構築する</title>
<published>2024-07-22T00:00:00+00:00</published>
<updated>2024-07-22T00:00:00+00:00</updated>
<author>
<name>Unknown</name>
</author>
<link rel="alternate" href="https://site.little-method.com/blog/build-terraria-server/" type="text/html"/>
<id>https://site.little-method.com/blog/build-terraria-server/</id>
<content type="html"><h1 id="gai-yao">概要</h1>
<p><a href="https://hub.docker.com/r/beardedio/terraria">beardedio/terraria</a> を使用して Terraria のサーバーを構築します。</p>
<h1 id="qian-ti-tiao-jian">前提条件</h1>
<ul>
<li><a href="https://www.docker.com/">Docker</a>, <a href="https://docs.docker.com/compose/install/">Docker Compose</a> が使用できる必要があります。</li>
</ul>
<h1 id="sabanogou-zhu">サーバーの構築</h1>
<p>Terraria のサーバーを構築します。</p>
<h2 id="xin-siiwarudonosheng-cheng">新しいワールドの生成</h2>
<p>Docker を使用して新しいワールドを生成します。</p>
<ol>
<li>
<p><a href="https://github.com/beardedio/terraria?tab=readme-ov-file#generating-a-new-world">Generating a new world</a> を参考に次のコマンドを実行しワールドの生成を開始します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">sudo</span><span> docker run</span><span style="color:#bf616a;"> --rm -it -p</span><span> 7777:7777 \
</span><span style="color:#bf616a;"> -v</span><span> /home/terraria/terraria/config:/config \
</span><span style="color:#bf616a;"> --name</span><span>=terraria \
</span><span> ghcr.io/beardedio/terraria:latest
</span></code></pre>
</li>
<li>
<p><code>n</code> を入力して新しいワールドの生成を選択します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Starting</span><span> container, CMD: ./TerrariaServer</span><span style="color:#bf616a;"> -x64 -config</span><span> /config/serverconfig.txt</span><span style="color:#bf616a;"> -banlist</span><span> /config/banlist.txt
</span><span style="color:#bf616a;">Error</span><span> Logging Enabled.
</span><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">n</span><span> New World
</span><span style="color:#bf616a;">d </span><span>&lt;number&gt; Delete World
</span><span>
</span><span style="color:#bf616a;">Choose</span><span> World: n
</span></code></pre>
</li>
<li>
<p>ワールドのサイズを選択します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">1</span><span> Small
</span><span style="color:#bf616a;">2</span><span> Medium
</span><span style="color:#bf616a;">3</span><span> Large
</span><span>
</span><span style="color:#bf616a;">Choose</span><span> size: 3
</span></code></pre>
</li>
<li>
<p>ワールドの難易度を選択します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">1</span><span> Classic
</span><span style="color:#bf616a;">2</span><span> Expert
</span><span style="color:#bf616a;">3</span><span> Master
</span><span style="color:#bf616a;">4</span><span> Journey
</span><span>
</span><span style="color:#bf616a;">Choose</span><span> difficulty: 1
</span></code></pre>
</li>
<li>
<p>Evil を選択します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">1</span><span> Random
</span><span style="color:#bf616a;">2</span><span> Corrupt
</span><span style="color:#bf616a;">3</span><span> Crimson
</span><span>
</span><span style="color:#bf616a;">Choose</span><span> world evil: 1
</span></code></pre>
</li>
<li>
<p>Seed を選択します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">Enter</span><span> Seed (Leave Blank For Random)</span><span style="color:#96b5b4;">:
</span></code></pre>
</li>
<li>
<p>ワールド名を入力します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">Enter</span><span> world name: test_world
</span></code></pre>
</li>
<li>
<p>上記で入力したワールド名を選択します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">1</span><span> test_world
</span><span style="color:#bf616a;">n</span><span> New World
</span><span style="color:#bf616a;">d </span><span>&lt;number&gt; Delete World
</span><span>
</span><span style="color:#bf616a;">Choose</span><span> World: 1
</span></code></pre>
</li>
<li>
<p>ワールドの最大人数を入力します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">Max</span><span> players (press enter for 16)</span><span style="color:#96b5b4;">:</span><span> 8
</span></code></pre>
</li>
<li>
<p>ポート番号を入力します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">Server</span><span> port (press enter for 7777)</span><span style="color:#96b5b4;">:
</span></code></pre>
</li>
<li>
<p>Port forward の設定を入力します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">Automatically</span><span> forward port? (y/n)</span><span style="color:#96b5b4;">:</span><span> n
</span></code></pre>
</li>
<li>
<p>ワールドのパスワードを設定します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Terraria</span><span> Server v1.4.4.9
</span><span>
</span><span style="color:#bf616a;">Server</span><span> password (press enter for none)</span><span style="color:#96b5b4;">:
</span></code></pre>
</li>
<li>
<p>ワールドの生成が完了しサーバーが起動します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">Listening</span><span> on port 7777
</span><span style="color:#bf616a;">Type </span><span>&#39;</span><span style="color:#a3be8c;">help</span><span>&#39; for a list of commands.
</span><span>
</span><span style="color:#96b5b4;">:</span><span> Server started
</span></code></pre>
</li>
<li>
<p>クライアントからワールドに接続できることを確認します。</p>
</li>
<li>
<p><code>Ctl</code> + <code>C</code> キーを入力しサーバーを停止します。</p>
</li>
</ol>
<h2 id="ji-cun-nowarudodesabawogou-zhu">既存のワールドでサーバーを構築</h2>
<p>Docker Compose を使用してサーバーを起動します。</p>
<ol>
<li>
<p><a href="https://github.com/beardedio/terraria?tab=readme-ov-file#example-docker-compose-file">Example Docker Compose file</a> を参考に <code>docker-compose.yaml</code> を作成します。</p>
<ul>
<li>terraria &gt; environment でサーバーの設定を行います。
<ul>
<li>world: ワールドデータのファイル名を指定します。</li>
</ul>
</li>
</ul>
<pre data-lang="yaml" style="background-color:#2b303b;color:#c0c5ce;" class="language-yaml "><code class="language-yaml" data-lang="yaml"><span style="color:#bf616a;">version</span><span>: &quot;</span><span style="color:#a3be8c;">3</span><span>&quot;
</span><span>
</span><span style="color:#bf616a;">services</span><span>:
</span><span style="color:#bf616a;">terraria</span><span>:
</span><span> </span><span style="color:#bf616a;">image</span><span>: </span><span style="color:#a3be8c;">ghcr.io/beardedio/terraria:latest
</span><span> </span><span style="color:#bf616a;">ports</span><span>:
</span><span> - &quot;</span><span style="color:#a3be8c;">7777:7777</span><span>&quot;
</span><span> </span><span style="color:#bf616a;">restart</span><span>: </span><span style="color:#a3be8c;">unless-stopped
</span><span> </span><span style="color:#bf616a;">environment</span><span>:
</span><span> - </span><span style="color:#a3be8c;">world=test_world.wld
</span><span> </span><span style="color:#bf616a;">volumes</span><span>:
</span><span> - </span><span style="color:#a3be8c;">/home/terraria/terraria/config:/config
</span><span> </span><span style="color:#bf616a;">tty</span><span>: </span><span style="color:#d08770;">true
</span><span> </span><span style="color:#bf616a;">stdin_open</span><span>: </span><span style="color:#d08770;">true
</span></code></pre>
</li>
</ol>
<h1 id="sabanoqi-dong-ting-zhi">サーバーの起動/停止</h1>
<ul>
<li>
<p>コンテナを起動します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">docker</span><span> compose up</span><span style="color:#bf616a;"> -d
</span></code></pre>
</li>
<li>
<p>コンテナを停止します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">docker</span><span> compose down
</span></code></pre>
</li>
</ul>
<h1 id="sabanogong-kai">サーバーの公開</h1>
<p><a href="/tags/tunnel/">Tunnel を構築して自宅サーバーを公開する方法</a> を参考にしてください。</p>
</content>
</entry>
<entry xml:lang="en">
<title>Ark Survival Ascended のサーバーを構築する</title>
<published>2024-03-16T00:00:00+00:00</published>
<updated>2024-03-30T00:00:00+00:00</updated>
<author>
<name>Unknown</name>
</author>
<link rel="alternate" href="https://site.little-method.com/blog/build-ark-survival-ascended-server/" type="text/html"/>
<id>https://site.little-method.com/blog/build-ark-survival-ascended-server/</id>
<content type="html"><h1 id="gai-yao">概要</h1>
<p><a href="https://github.com/mschnitzer/ark-survival-ascended-linux-container-image">ark-survival-ascended-linux-container-image</a> を使用して <a href="https://store.steampowered.com/app/2399830/ARK_Survival_Ascended/?l=japanese">Ark Survival Ascended</a> のサーバーを構築します。</p>
<h1 id="qian-ti-tiao-jian">前提条件</h1>
<ul>
<li><a href="https://www.docker.com/">Docker</a>, <a href="https://docs.docker.com/compose/install/">Docker Compose</a> が使用できる必要があります。</li>
</ul>
<h1 id="can-kao-qing-bao">参考情報</h1>
<ul>
<li><a href="https://ark.wiki.gg/wiki/Dedicated_server_setup">Dedicated server setup</a></li>
<li><a href="https://ark.wiki.gg/wiki/Server_configuration">Server configuration</a></li>
</ul>
<h1 id="sabanogou-zhu">サーバーの構築</h1>
<p>Ark Survival Ascended のサーバーを構築します。</p>
<ol>
<li>
<p>サーバーに必要なフォルダを作成します。</p>
<ul>
<li>steam-1</li>
<li>steamcmd-1</li>
<li>server-files-1</li>
<li>cluster-shared</li>
</ul>
</li>
<li>
<p><a href="https://github.com/mschnitzer/ark-survival-ascended-linux-container-image/blob/main/docker-compose.yml">Docker Compose</a> を参考に <code>docker-compose.yaml</code> を作成します。</p>
<ul>
<li>asa-server-1 &gt; environment &gt; ASA_START_PARAMS でサーバーの設定を行います。
<ul>
<li>TheIsland_WP: マップ <a href="https://ark.wiki.gg/wiki/The_Island">The Island</a>を指定します。</li>
<li>Port: ゲームポートを指定します。</li>
<li>RCONPort: RCON ポートを指定します。</li>
<li>RCONEnabled: RCON を有効にします。</li>
<li>SessionName: セッション名を指定します。</li>
<li>ServerPassword: サーバーのパスワードを指定します。</li>
<li>-WinLiveMaxPlayers: サーバー上で同時にプレイできるプレーヤーの最大数を指定します。</li>
<li>-culture: サーバーの出力言語を指定します。</li>
<li>-ClusterDirOverride: Cross-ARK Data Transfer のクロスサーバーストレージの場所を指定します。</li>
</ul>
</li>
</ul>
<pre data-lang="yaml" style="background-color:#2b303b;color:#c0c5ce;" class="language-yaml "><code class="language-yaml" data-lang="yaml"><span style="color:#bf616a;">version</span><span>: &quot;</span><span style="color:#a3be8c;">3.3</span><span>&quot;
</span><span style="color:#bf616a;">services</span><span>:
</span><span style="color:#bf616a;">asa-server-1</span><span>:
</span><span> </span><span style="color:#bf616a;">container_name</span><span>: </span><span style="color:#a3be8c;">asa-server-1
</span><span> </span><span style="color:#bf616a;">hostname</span><span>: </span><span style="color:#a3be8c;">asa-server-1
</span><span> </span><span style="color:#bf616a;">entrypoint</span><span>: &quot;</span><span style="color:#a3be8c;">/usr/bin/start_server</span><span>&quot;
</span><span> </span><span style="color:#bf616a;">user</span><span>: </span><span style="color:#a3be8c;">gameserver
</span><span> </span><span style="color:#bf616a;">image</span><span>: &quot;</span><span style="color:#a3be8c;">mschnitzer/asa-linux-server:latest</span><span>&quot;
</span><span> </span><span style="color:#bf616a;">environment</span><span>:
</span><span> - </span><span style="color:#a3be8c;">ASA_START_PARAMS=TheIsland_WP?listen?Port=7777?RCONPort=27020?RCONEnabled=True?SessionName=MyPrivateArkServer?ServerPassword=mypassword -WinLiveMaxPlayers=16 -culture=ja -ClusterDirOverride=&quot;/home/gameserver/cluster-shared&quot; </span><span style="color:#65737e;">#PUT clusterid=SECRET here to enable transfers
</span><span> - </span><span style="color:#a3be8c;">ENABLE_DEBUG=0
</span><span> - </span><span style="color:#a3be8c;">TZ=Asia/Tokyo
</span><span> </span><span style="color:#bf616a;">ports</span><span>:
</span><span> </span><span style="color:#65737e;"># Game port for player connections through the server browser
</span><span> - </span><span style="color:#a3be8c;">0.0.0.0:7777:7777/udp
</span><span> </span><span style="color:#65737e;"># RCON port for remote server administration
</span><span> - </span><span style="color:#a3be8c;">0.0.0.0:27020:27020/tcp
</span><span> </span><span style="color:#bf616a;">depends_on</span><span>:
</span><span> - </span><span style="color:#a3be8c;">set-permissions-1
</span><span> </span><span style="color:#bf616a;">volumes</span><span>:
</span><span> - </span><span style="color:#a3be8c;">./steam-1:/home/gameserver/Steam:rw
</span><span> - </span><span style="color:#a3be8c;">./steamcmd-1:/home/gameserver/steamcmd:rw
</span><span> - </span><span style="color:#a3be8c;">./server-files-1:/home/gameserver/server-files:rw
</span><span> - </span><span style="color:#a3be8c;">./cluster-shared:/home/gameserver/cluster-shared:rw
</span><span> </span><span style="color:#bf616a;">networks</span><span>:
</span><span> </span><span style="color:#bf616a;">asa-network</span><span>:
</span><span style="color:#bf616a;">set-permissions-1</span><span>:
</span><span> </span><span style="color:#bf616a;">entrypoint</span><span>: &quot;</span><span style="color:#a3be8c;">/bin/bash -c &#39;chown -R 25000:25000 /steam ; chown -R 25000:25000 /steamcmd ; chown -R 25000:25000 /server-files ; chown -R 25000:25000 /cluster-shared&#39;</span><span>&quot;
</span><span> </span><span style="color:#bf616a;">user</span><span>: </span><span style="color:#a3be8c;">root
</span><span> </span><span style="color:#bf616a;">image</span><span>: &quot;</span><span style="color:#a3be8c;">opensuse/leap</span><span>&quot;
</span><span> </span><span style="color:#bf616a;">volumes</span><span>:
</span><span> - </span><span style="color:#a3be8c;">./steam-1:/steam:rw
</span><span> - </span><span style="color:#a3be8c;">./steamcmd-1:/steamcmd:rw
</span><span> - </span><span style="color:#a3be8c;">./server-files-1:/server-files:rw
</span><span> - </span><span style="color:#a3be8c;">./cluster-shared:/cluster-shared:rw
</span><span style="color:#bf616a;">volumes</span><span>:
</span><span> </span><span style="color:#bf616a;">cluster-shared</span><span>:
</span><span> </span><span style="color:#bf616a;">steam-1</span><span>:
</span><span> </span><span style="color:#bf616a;">steamcmd-1</span><span>:
</span><span> </span><span style="color:#bf616a;">server-files-1</span><span>:
</span><span style="color:#bf616a;">networks</span><span>:
</span><span> </span><span style="color:#bf616a;">asa-network</span><span>:
</span><span> </span><span style="color:#bf616a;">attachable</span><span>: </span><span style="color:#d08770;">true
</span><span> </span><span style="color:#bf616a;">driver</span><span>: </span><span style="color:#a3be8c;">bridge
</span><span> </span><span style="color:#bf616a;">driver_opts</span><span>:
</span><span> </span><span style="color:#bf616a;">com.docker.network.bridge.name</span><span>: &quot;</span><span style="color:#a3be8c;">asanet</span><span>&quot;
</span></code></pre>
</li>
</ol>
<h1 id="sabanoqi-dong-ting-zhi">サーバーの起動/停止</h1>
<ul>
<li>
<p>コンテナを起動します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">docker</span><span> compose up</span><span style="color:#bf616a;"> -d
</span></code></pre>
</li>
<li>
<p>コンテナを停止します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">docker</span><span> compose down
</span></code></pre>
</li>
<li>
<p>コンテナを削除します。</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">docker</span><span> compose rm
</span></code></pre>
</li>
</ul>
<h1 id="sabahejie-sok">サーバへ接続</h1>
<p>クライアントからサーバーに接続します。</p>
<h2 id="sababurauzakarajie-sok">サーバーブラウザから接続</h2>
<ol>
<li>
<p>ゲームを起動して <code>ゲームに参加</code> を選択します。</p>
</li>