Skip to content

Latest commit

 

History

History
579 lines (377 loc) · 20.3 KB

README.ko.md

File metadata and controls

579 lines (377 loc) · 20.3 KB
Raw

[ English | 中文 | Deutsch | Español | Français | Italiano | 日本語 | 한국어 | Português | Русский ]

NOTE: This manual has not yet been translated for Pyxel version 1.5.0. We are looking for volunteers to translate and check for mistakes!

Pyxel (픽셀) 은 Python을 위한 레트로 게임 엔진입니다.

16가지 색상만 사용하거나 동시에 4가지 소리만 재생하는 등 레트로 게임에 나올 법한 사양으로, Python에서 픽셀 아트 스타일의 게임을 마음껏 만들 수 있습니다.

The specifications of Pyxel are referring to awesome PICO-8 and TIC-80.

Pyxel은 오픈 소스로, 무료로 자유롭게 사용할 수 있습니다. Pyxel과 함께 레트로 스타일의 게임을 만들어보세요!

사양

  • Windows, Mac, Linux 지원
  • Programming with Python
  • 16 color palette
  • 256x256 크기의 이미지 뱅크 3개
  • 256x256 크기의 타일 맵 8개
  • 4개의 사운드 동시 재생, 64개의 정의 가능한 사운드
  • 임의의 사운드를 조합 가능한 8개의 음악
  • 키보드, 마우스, 게임패드 입력
  • 이미지/사운드 에디터

색상 팔레트



설치 방법

There are two types of Pyxel, a packaged version and a standalone version.

Install Packaged Version

The packaged version of Pyxel uses Pyxel as a Python extension module.

Recommended for those who are familiar with managing Python packages using the pip command or who want to develop full-fledged Python applications.

Windows

After installing Python3 (version 3.7 or higher), run the following command:

pip install -U pyxel

Mac

After installing Python3 (version 3.7 or higher), run the following command:

pip3 install -U pyxel

Linux

After installing the SDL2 package (libsdl2-dev for Ubuntu), Python3 (version 3.7 or higher), and python3-pip, run the following command:

pip3 install -U pyxel

If the above doesn't work, try self-building by following the steps below after installing cmake and rust:

git clone https://github.com/kitao/pyxel.git
cd pyxel
make clean all RELEASE=1
pip3 install .

Install Standalone Version

The standalone version of Pyxel uses Pyxel as a standalone tool that does not depend on Python.

Recommended for those who want to start programming easily without worrying about Python settings, or those who want to play Pyxel games immediately.

Windows

Download and run the latest version of the Windows installer (pyxel-[version]-windows-setup.exe) from the Download Page.

Mac

After installing Homebrew, run the following commands:

brew tap kitao/pyxel
brew install pyxel

Linux

After installing the SDL2 package (libsdl2-dev for Ubuntu) and installing Homebrew, run the following commands:

brew tap kitao/pyxel
brew install pyxel

If the above doesn't work, try self-building the packaged version.

Try Pyxel Examples

Pyxel 설치 후, 아래 명령어를 사용해 현재 폴더에 Pyxel 예제를 복사할 수 있습니다:

pyxel copy_examples

복사되는 예제는 다음과 같습니다:

An examples can be executed with the following commands:

cd pyxel_examples
pyxel run 01_hello_pyxel.py

사용 방법

Pyxel 애플리케이션 작성 방법

After importing the Pyxel module in your python script, specify the window size with init function first, then starts the Pyxel application with run function.

import pyxel

pyxel.init(160, 120)

def update():
    if pyxel.btnp(pyxel.KEY_Q):
        pyxel.quit()

def draw():
    pyxel.cls(0)
    pyxel.rect(10, 10, 20, 20, 11)

pyxel.run(update, draw)

run 함수의 인자로는 프레임 갱신을 처리하는 update 함수와, 필요할 때 화면을 그리는 draw 함수가 사용됩니다.

실제 애플리케이션에서는 아래와 같이 클래스에서 Pyxel 코드를 감싸는 것이 좋습니다:

import pyxel

class App:
    def __init__(self):
        pyxel.init(160, 120)
        self.x = 0
        pyxel.run(self.update, self.draw)

    def update(self):
        self.x = (self.x + 1) % pyxel.width

    def draw(self):
        pyxel.cls(0)
        pyxel.rect(self.x, 0, 8, 8, 9)

App()

It is also possible to write simple code using show function and flip function to draw simple graphics and animations.

show function displays the screen and waits until the Esc key is pressed.

import pyxel

pyxel.init(120, 120)
pyxel.cls(1)
pyxel.circb(60, 60, 40, 7)
pyxel.show()

flip function updates the screen once.

import pyxel

pyxel.init(120, 80)

while True:
    pyxel.cls(3)
    pyxel.rectb(pyxel.frame_count % 160 - 40, 20, 40, 40, 7)
    pyxel.flip()

Run Pyxel Application

The created Python script can be executed with the following command:

pyxel run PYTHON_SCRIPT_FILE

For the packaged version, it can be executed like a normal Python script:

cd pyxel_examples
python3 PYTHON_SCRIPT_FILE

(For Windows, type python instead of python3)

특수 조작

Pyxel 애플리케이션 실행 중에, 아래의 특수 조작을 사용할 수 있습니다:

  • Esc
    애플리케이션 종료
  • Alt(Option)+1
    바탕 화면에 스크린샷 저장
  • Alt(Option)+2
    화면 캡쳐의 녹화 시작 시간 초기화
  • Alt(Option)+3
    화면 캡쳐 파일 을 바탕 화면에 저장 (최대 10초)
  • Alt(Option)+0
    성능 모니터 (fps, update time, and draw time)의 표시/표시 해제
  • Alt(Option)+Enter
    전체 화면 전환

리소스의 작성 방법

Pyxel Editor can create images and sounds used in a Pyxel application.

It starts with the following command:

pyxel edit [PYXEL_RESOURCE_FILE]

지정한 Pyxel 리소스 파일 (.pyxres)이 존재하는 경우에는 해당 파일을 불러오고, 존재하지 않는 경우 지정한 이름으로 새 리소스 파일을 생성합니다. 파일 이름을 생략했을 경우, 기본 파일 이름은 my_resource.pyxres입니다.

After starting Pyxel Editor, the file can be switched by dragging and dropping another resource file. If the resource file is dragged and dropped while holding down Ctrl(Cmd) key, only the resource type (Image/Tilemap/Sound/Music) that is currently being edited will be loaded. This operation enables to combine multiple resource files into one.

The created resource file can be loaded with load function.

Pyxel Editor는 다음과 같은 편집 모드가 있습니다:

이미지 에디터:

이미지 뱅크를 편집하는 화면입니다.

By dragging and dropping an image file (png/gif/jpeg) onto the Image Editor screen, the image can be loaded into the currently selected image bank.

타일 맵 에디터:

이미지 뱅크의 이미지를 타일 모양으로 늘어놓은 타일 맵을 편집하는 화면입니다.

사운드 에디터:

사운드를 편집하는 화면입니다.

음악 에디터:

사운드를 플레이 순서대로 늘어놓은 음악을 편집하는 화면입니다.

기타 리소스 작성 방법

Pyxel images and tilemaps can also be created by the following methods:

  • Create an image from a list of strings with Image.set function or Tilemap.set function
  • Load an image file (png/gif/jpeg) in Pyxel palette with Image.load function

Pyxel sounds can also be created in the following method:

  • Create a sound from strings with Sound.set function or Music.set function

각 함수의 사용법은 API 레퍼런스를 참조해주세요.

How to Distribute Application

Pyxel supports a dedicated application distribution file format (Pyxel application file) that works across platforms.

Create the Pyxel application file (.pyxapp) with the following command:

pyxel package APP_ROOT_DIR STARTUP_SCRIPT_FILE

If the application should include resources or additional modules, place them in the application folder.

The created application file can be executed with the following command:

pyxel play PYXEL_APP_FILE

API 레퍼런스

시스템

  • width, height
    화면의 가로/세로 크기

  • frame_count
    경과한 프레임의 수

  • init(width, height, [title], [fps], [quit_key], [capture_sec])
    Initialize the Pyxel application with screen size (width, height). The following can be specified as options: the window title with title, the frame rate with fps, the key to quit the application with quit_key, and the maximum recording time of the screen capture video with capture_sec.
    e.g. pyxel.init(160, 120, title="Pyxel with Options", fps=60, quit_key=pyxel.KEY_NONE, capture_sec=0)

  • run(update, draw)
    Start the Pyxel application and call update function for frame update and draw function for drawing.

  • show()
    Show the screen and wait until the Esc key is pressed. (Do not use in normal applications)

  • flip()
    Updates the screen once. (Do not use in normal applications)

  • quit()
    Quit the Pyxel application at the end of the current frame.

리소스

  • load(filename, [image], [tilemap], [sound], [music])
    Load the resource file (.pyxres). If False is specified for the resource type (image/tilemap/sound/music), the resource will not be loaded.

입력

  • mouse_x, mouse_y
    마우스 커서의 현재 좌표를 나타냅니다.

  • mouse_wheel
    마우스 휠의 현재 값을 나타냅니다.

  • btn(key)
    key가 눌리고 있으면 True, 눌리고 있지 않으면 False를 반환합니다. (키 정의 리스트)

  • btnp(key, [hold], [period])
    해당 프레임에 key가 눌리면 True, 눌리지 않으면 False를 반환합니다. hold와 period를 지정하면, hold 프레임 이상 key가 눌린 상태인 경우 period 프레임 간격으로 True를 반환합니다.

  • btnr(key)
    해당 프레임에 key가 떼어지면 True, 아니면 False를 반환합니다.

  • mouse(visible)
    visible이 True인 경우 마우스 커서를 표시하고, False라면 표시하지 않습니다. 마우스 커서가 보이지 않아도 마우스 커서의 좌표는 갱신됩니다.

그래픽

  • colors
    List of the palette display colors. The display color is specified by a 24-bit numerical value. Use colors.from_list and colors.to_list to directly assign and retrieve Python lists.
    e.g. org_colors = pyxel.colors.to_list(); pyxel.colors[15] = 0x112233; pyxel.colors.from_list(org_colors)

  • image(img)
    Operate the image bank img (0-2). (See the Image class)
    e.g. pyxel.image(0).load(0, 0, "title.png")

  • tilemap(tm)
    타일 맵 tm(0-7)을 조작합니다(타일 맵 클래스를 참조).

  • clip(x, y, w, h)
    화면의 드로잉 영역을 (x, y)로 설정하고, 폭을 w, 높이를 h로 설정합니다. clip()과 같이 사용하면 드로잉 영역을 초기 상태(전체 화면)으로 돌립니다.

  • pal(col1, col2)
    드로잉 시 col1를 col2로 대체합니다. pal()과 같이 사용하면 초기 상태로 돌립니다.

  • cls(col)
    화면을 col 색으로 지웁니다.

  • pget(x, y)
    (x, y) 좌표의 색상 값을 가져옵니다.

  • pset(x, y, col)
    col 색을 사용해 (x, y) 좌표에 픽셀을 찍습니다.

  • line(x1, y1, x2, y2, col)
    col 색을 사용해 (x1, y1)부터 (x2, y2)까지 직선을 그립니다.

  • rect(x, y, w, h, col)
    가로 w, 세로 h의 크기로 col 색을 사용해 직사각형을 (x, y) 좌표에 그립니다.

  • rectb(x, y, w, h, col)
    가로 w, 세로 h의 크기로 col 색을 사용해 직사각형 테두리를 (x, y) 좌표에 그립니다. (테두리 안쪽에 색상을 채우지 않음)

  • circ(x, y, r, col)
    반경 r, col 색의 원을 (x, y) 좌표에 그립니다.

  • circb(x, y, r, col)
    반경 r, col 색의 원 테두리를 (x, y) 좌표에 그립니다. (테두리 안쪽에 색상을 채우지 않음)

  • tri(x1, y1, x2, y2, x3, y3, col)
    꼭짓점 좌표 (x1, y1), (x2, y2), (x3, y3)를 기준으로 col 색상의 삼각형을 그립니다.

  • trib(x1, y1, x2, y2, x3, y3, col)
    꼭짓점 좌표 (x1, y1), (x2, y2), (x3, y3)를 기준으로 col 색상의 삼각형 테두리를 그립니다. (테두리 안쪽에 색상을 채우지 않음)

  • blt(x, y, img, u, v, w, h, [colkey])
    이미지 뱅크 img(0-2)의 (u, v)부터 (w, h)까지의 영역을 (x, y) 좌표에 복사합니다. w, h의 값을 마이너스로 설정하면, 각각 수평, 수직 방향으로 반전됩니다. colkey로 색을 지정하면 투명 색상으로 처리됩니다.

  • bltm(x, y, tm, u, v, w, h, [colkey])
    Draw the tilemap tm (0-7) to (x, y) according to the tile information of size (w, h) from (u, v). If colkey is specified, treated as transparent color. The size of a tile is 8x8 pixels and is stored in a tilemap as a tuple of (x in tile, y in tile).

  • text(x, y, s, col)
    col 색을 사용해 문자열 s를 (x, y) 좌표에 그립니다.

오디오

  • sound(snd)
    사운드 snd(0-63) 를 조작합니다. (사운드 클래스를 참조)
    예: pyxel.sound(0).speed = 60

  • music(msc)
    음악 msc(0-7) 를 조작합니다(음악 클래스를 참조).

  • play_pos(ch)
    Get the sound playback position of channel ch (0-3) as a tuple of (sound no, note no). Returns None when playback is stopped.

  • play(ch, snd, loop=False)
    Play the sound snd (0-63) on channel ch (0-3). If snd is a list, it will be played in order. If True is specified for loop, loop playback is performed.

  • playm(msc, loop=False)
    Play the music msc (0-7). If True is specified for loop, loop playback is performed.

  • stop([ch])
    Stops playback of the specified channel ch (0-3). stop() to stop playing all channels.

이미지 클래스

  • width, height
    이미지의 가로/세로 크기

  • data
    이미지의 데이터 (256x256 크기의 2차원 리스트)

  • get(x, y)
    이미지의 (x,y) 데이터를 가져옵니다.

  • set(x, y, data)
    Set the image at (x, y) by a list of strings.
    e.g. pyxel.image(0).set(10, 10, ["1234", "5678", "9abc", "defg"])

  • load(x, y, filename)
    Load the image file (png/gif/jpeg) at (x, y).

타일 맵 클래스

  • width, height
    타일 맵의 가로/세로 크기

  • refimg
    The image bank (0-2) referenced by the tilemap

  • set(x, y, data)
    Set the tilemap at (x, y) by a list of strings.
    e.g. pyxel.tilemap(0).set(0, 0, ["000102", "202122", "a0a1a2", "b0b1b2"])

  • pget(x, y)
    Get the tile at (x, y). A tile is a tuple of (x in tile, y in tile).

  • pset(x, y, tile)
    Draw a tile at (x, y). A tile is a tuple of (x in tile, y in tile).

사운드 클래스

  • notes
    List of notes (0-127). The higher the number, the higher the pitch, and at 33 it becomes 'A2'(440Hz). The rest is -1.

  • tones
    List of tones (0:Triangle / 1:Square / 2:Pulse / 3:Noise)

  • volumes
    List of volumes (0-7)

  • effects
    List of effects (0:None / 1:Slide / 2:Vibrato / 3:FadeOut)

  • speed
    Playback speed. 1 is the fastest, and the larger the number, the slower the playback speed. At 120, the length of one note becomes 1 second.

  • set(notes, tones, volumes, effects, speed)
    Set notes, tones, volumes, and effects with a string. If the tones, volumes, and effects length are shorter than the notes, it is repeated from the beginning.

  • set_notes(notes)
    Set the notes with a string made of 'CDEFGAB'+'#-'+'0123' or 'R'. Case-insensitive and whitespace is ignored.
    e.g. pyxel.sound(0).set_note("G2B-2D3R RF3F3F3")

  • set_tones(tones)
    Set the tones with a string made of 'TSPN'. Case-insensitive and whitespace is ignored.
    e.g. pyxel.sound(0).set_tone("TTSS PPPN")

  • set_volumes(volumes)
    Set the volumes with a string made of '01234567'. Case-insensitive and whitespace is ignored.
    e.g. pyxel.sound(0).set_volume("7777 7531")

  • set_effects(effects)
    Set the effects with a string made of 'NSVF'. Case-insensitive and whitespace is ignored.
    e.g. pyxel.sound(0).set_effect("NFNF NVVS")

음악 클래스

  • sequences
    Two-dimensional list of sounds (0-63) listed by the number of channels

  • set(seq0, seq1, seq2, seq3)
    Set the lists of sound (0-63) of all channels. If an empty list is specified, that channel is not used for playback.
    e.g. pyxel.music(0).set([0, 1], [2, 3], [4], [])

Advanced APIs

Pyxel has "advanced APIs" that are not mentioned in this reference because they "may confuse users" or "need specialized knowledge to use".

If you are familiar with your skills, try to create amazing works with this as a clue!

컨트리뷰션 방법

Submitting Issue

Use the Issue Tracker to submit bug reports and feature/enhancement requests. Before submitting a new issue, ensure that there is no similar open issue.

Manual Testing

Anyone manually testing the code and reporting bugs or suggestions for enhancements in the Issue Tracker are very welcome!

Submitting Pull Request

패치나 수정 요청은 풀 리퀘스트(PR)로 받고 있습니다. 제출하기 전에 문제가 이미 해결되지 않았는지 Issue Tracker 페이지에서 확인 부탁드립니다.

제출한 풀 리퀘스트는 MIT License에 따라 게시하기를 동의한 것으로 간주됩니다.

기타 정보

라이선스 정보

Pyxel is under MIT License. It can be reused within proprietary software, provided that all copies of the software or its substantial portions include a copy of the terms of the MIT License and also a copyright notice.