|
1 | | -# py2hackCraft |
| 1 | +# py2hackCraft2 |
2 | 2 |
|
3 | 3 | Python client library for hackCraft2 |
4 | 4 |
|
| 5 | +## 概要 |
| 6 | + |
| 7 | +py2hackCraft2は、hackCraft2にPythonから接続して命令を送るためのライブラリです。 |
| 8 | + |
| 9 | +hackCraft2はMinecraft Java Editionのサーバープラグインで、このプラグインを導入することで、Minecraft上でプログラミングが可能になります。hackCraft2の詳細については、[hackCraft2のダウンロードページ](https://github.com/yokmama/8x9Craft-download)をご参照ください。 |
| 10 | + |
| 11 | +Minecraftについての詳細は、インターネットで検索していただければと思います。 |
| 12 | + |
| 13 | +py2hackCraft2を使用することで、hackCraft2が導入されたMinecraftサーバーに対して、Pythonから直接命令を送ることができます。 |
| 14 | + |
5 | 15 | ## ドキュメント |
6 | 16 |
|
7 | | -詳細なAPIリファレンスと使用例は[ドキュメント](https://github.com/0x48lab/hackCraft2-python)を参照してください。 |
8 | | - |
9 | | -## デプロイ手順 |
10 | | - |
11 | | -### 事前準備 |
12 | | - |
13 | | -1. PyPIアカウントの設定 |
14 | | - - [PyPI](https://pypi.org)でアカウントを作成（まだの場合） |
15 | | - - Account Settings → API tokens で新しいトークンを生成 |
16 | | - - トークンをGitHubリポジトリのSecretsに追加 |
17 | | - - GitHubリポジトリの Settings → Secrets → New repository secret |
18 | | - - 名前: `PYPI_API_TOKEN` |
19 | | - - 値: PyPIで生成したトークン |
20 | | - |
21 | | -2. パッケージ情報の更新 |
22 | | - - `setup.py`の以下の項目を確認・更新 |
23 | | - - `version`: 新しいバージョン番号（セマンティックバージョニング推奨） |
24 | | - - `author`: 作者名 |
25 | | - - `author_email`: 連絡先メールアドレス |
26 | | - - `url`: GitHubリポジトリのURL |
27 | | - - `description`: パッケージの説明 |
28 | | - - `README.md`の更新（必要に応じて） |
29 | | - - ドキュメントの更新（必要に応じて） |
30 | | - |
31 | | -### デプロイ方法 |
32 | | - |
33 | | -1. 変更をコミット |
34 | | - ```bash |
35 | | - git add . |
36 | | - git commit -m "Update package information and documentation" |
37 | | - git push origin main |
38 | | - ``` |
39 | | - |
40 | | -2. 新しいバージョンのタグを作成してプッシュ |
41 | | - ```bash |
42 | | - git tag v0.1.0 # バージョン番号を適切に設定 |
43 | | - git push origin v0.1.0 |
44 | | - ``` |
45 | | - |
46 | | -3. GitHub Actionsの実行 |
47 | | - - タグがプッシュされると、自動的にGitHub Actionsが実行されます |
48 | | - - Actionsタブでデプロイの進行状況を確認できます |
49 | | - - 成功すると、新しいバージョンがPyPIに公開されます |
50 | | - - ドキュメントがGitHub Pagesに自動的にデプロイされます |
51 | | - |
52 | | -### 注意事項 |
53 | | - |
54 | | -- バージョン番号は必ず更新してください（同じバージョンでの再デプロイはできません） |
55 | | -- PyPIトークンは安全に管理し、GitHub Secretsとして保存してください |
56 | | -- デプロイ前に`setup.py`と`README.md`の内容が正しいことを確認してください |
57 | | -- テストを実行して、パッケージが正しく動作することを確認してください |
58 | | -- ドキュメントの更新が必要な場合は、`docs/`ディレクトリ内のファイルを編集してください |
| 17 | +詳細なAPIリファレンスと使用例は[ドキュメント](https://0x48lab.github.io/hackCraft2-python/)を参照してください。 |
59 | 18 |
|
60 | 19 | ## インストール方法 |
61 | 20 |
|
62 | 21 | ```bash |
63 | | -pip install py2hackCraft |
| 22 | +pip install py2hackCraft2 |
64 | 23 | ``` |
65 | 24 |
|
66 | 25 | ## 使用方法 |
67 | 26 |
|
68 | 27 | ```python |
69 | | -from py2hackCraft.modules import Player, Volume, LocationFactory |
| 28 | +from py2hackCraft2.modules import Player, Volume, LocationFactory |
70 | 29 |
|
71 | 30 | # プレイヤーの接続 |
72 | 31 | player = Player("your_name") |
|
0 commit comments