Skip to content

Commit

Permalink
Updated the Q&A
Browse files Browse the repository at this point in the history
  • Loading branch information
kitao committed Oct 9, 2024
1 parent a3c3bdc commit e459bda
Show file tree
Hide file tree
Showing 2 changed files with 144 additions and 0 deletions.
72 changes: 72 additions & 0 deletions docs/faq-en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Pyxel FAQ

## Migrating to a New Version

<details>
<summary>How to migrate code to version 1.5</summary>

To make your code compatible with version 1.5, follow these steps:

- Rename the `caption` option in `init` to `title`
- Rename the `scale` option in `init` to `display_scale`
- Remove the `palette` option from `init`. You can modify the palette colors via the `colors` array after initialization.
- Remove the `fullscreen` option from `init`. Use the `fullscreen` function to toggle fullscreen after initialization.
- If you encounter undefined errors, rename the key according to the [key definitions](https://github.com/kitao/pyxel/blob/main/python/pyxel/__init__.pyi).
- Change `get` and `set` in the `Image` and `Tilemap` classes to `pget` and `pset` respectively.
- Multiply the `u`, `v`, `w`, and `h` parameters of `bltm` by 8, as `bltm` now operates in pixel units.
- Update the members and methods in the `Sound` and `Music` classes based on the new naming conventions.
</details>

<details>
<summary>Why can’t I use the `pyxeleditor` command in version 1.5+?</summary>

Starting from version 1.5, Pyxel's tools have been integrated into the `pyxel` command. To access the resource editor, use the following command: `pyxel edit [PYXEL_RESOURCE_FILE]`.

</details>

## Learning Pyxel

<details>
<summary>Where do I start to learn Pyxel?</summary>

I recommend starting by experimenting with Pyxel's example code. Try the following examples in this order: 01, 05, 03, 04, and 02.

</details>

<details>
<summary>Are there any books on Pyxel?</summary>

There are currently two books available in Japanese, though neither is authored by Pyxel’s developer. Unfortunately, there are no English versions at the moment, but more Pyxel books, including English editions, are likely to be released in the future!

</details>

## API Specification and Usage

<details>
<summary>What is the difference between the `update` and `draw` functions?</summary>

The `update` function is called every frame, whereas the `draw` function may be skipped if the frame processing time exceeds the allowed limit. This design allows Pyxel to maintain smooth animations regardless of rendering load or interrupt handling.

</details>

## Using Pyxel Tools

## Future Development Plans

<details>
<summary>What features are planned for future Pyxel releases?</summary>

Upcoming features include:

- Improve the usability of Pyxel Editor
- Python and Pyxel tutorials aimed at children
</details>

## Licensing and Sponsorship

<details>
<summary>Can I use Pyxel for commercial purposes without permission?</summary>

Yes, you can use Pyxel for commercial purposes as long as you follow the MIT License and credit the developer. However, I’d greatly appreciate it if you consider sponsoring Pyxel!

</details>
72 changes: 72 additions & 0 deletions docs/faq-jp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Pyxel よくある質問

## 新バージョンへの移行方法

<details>
<summary>バージョン1.5への移行方法</summary>

コードをバージョン 1.5 に対応させるために、以下の変更を行ってください。

- `init``caption` オプションを `title` にリネーム
- `init``scale` オプションを `display_scale` にリネーム
- `init` から `palette` オプションを削除。初期化後に `colors` 配列でパレットカラーを変更できます。
- `init` から `fullscreen` オプションを削除。初期化後に `fullscreen` 関数でフルスクリーンを切り替えることができます。
- 未定義エラーが発生した場合、[キー定義](https://github.com/kitao/pyxel/blob/main/python/pyxel/__init__.pyi) に従ってキー名をリネームしてください。
- `Image` クラスおよび `Tilemap` クラスの `get``set` をそれぞれ `pget``pset` に変更
- `bltm``u`, `v`, `w`, `h` パラメータを 8 倍に変更。`bltm` はピクセル単位で動作するようになりました。
- `Sound` および `Music` クラスのメンバーとメソッドを新しい命名規則に従って更新
</details>

<details>
<summary>バージョン1.5以降で`pyxeleditor`コマンドが使えないのはなぜですか?</summary>

バージョン 1.5 以降、Pyxel のツールは`pyxel`コマンドに統合されました。リソースエディタにアクセスするには、次のコマンドを使用してください: `pyxel edit [PYXEL_RESOURCE_FILE]`

</details>

## Pyxel の学び方

<details>
<summary>Pyxelを学習するにはどこから始めればいいですか?</summary>

Pyxel のサンプルコードを試してみることをお勧めします。次の順に試してください: 01, 05, 03, 04, 02。

</details>

<details>
<summary>Pyxelに関する書籍はありますか?</summary>

現在、日本語で 2 冊の本が出版されていますが、どちらも Pyxel の開発者によるものではありません。残念ながら、今のところ英語版はありませんが、今後英語版を含む Pyxel の本がさらに出版される可能性があります!

</details>

## API 仕様と使い方

<details>
<summary>`update`関数と`draw`関数の違いは何ですか?</summary>

`update`関数は毎フレーム呼び出されますが、`draw`関数は処理時間が許容限界を超えた場合にスキップされることがあります。この設計により、レンダリング負荷や割り込み処理にかかわらず、Pyxel は滑らかなアニメーションを維持します。

</details>

## Pyxel ツールの使い方

## 今後の開発計画

<details>
<summary>今後のPyxelリリースで追加される予定の機能は何ですか?</summary>

今後の機能には、以下が含まれます:

- Pyxel Editor の使い勝手の向上
- 子ども向けの Python と Pyxel のチュートリアル
</details>

## ライセンスとスポンサーシップ

<details>
<summary>Pyxelを商業目的で許可なしに使用できますか?</summary>

はい、MIT ライセンスに従い、開発者にクレジットを表記すれば、開発者の許可なく商業目的で Pyxel を使用できます。ただし、Pyxel をスポンサーしていただけると非常にありがたいです!

</details>

0 comments on commit e459bda

Please sign in to comment.