chrisnorman7 / earwax

An audio game engine for fast prototyping
Mozilla Public License 2.0
7 stars 3 forks source link

Tutorial for Getting Started #1

Closed tbreitenfeldt closed 3 years ago

tbreitenfeldt commented 3 years ago

Hi, I decided I would take a look at your library again for building an audio game, and found like last time there is no quick and easy way of getting up and going with this library.

I would like to propose a new tutorial that is linked to from your github readme for getting started with earwax. In the getting started, you can include your process for setting up a project using the earwax command line tools, and walking through creating a basic game using the tools that earwax provides. This would make it a lot easier for people new to earwax to get started using the library without having to read a bunch of documentation and example code.

I see you have a couple tutorials already on various features of earwax, so it shouldn't be to dificult to write up a getting started guide.

I was trying to run the commandline tool for running the earwax cli tools, although the docs on this is sparce, and I was not exactly sure what I needed to do. All that is provided in the docs is earwax.cmd.cmd_main() along with a couple other function calls. This is not how I am used to running python command line tools. Usually it is a separate executable or bat file that is in the scripts folder. I was not sure how to turn this, so I tried py -m earwax.cmd.cmd_main() and got an exception:

C:\Users\timot\Documents>py -m earwax.cmd.cmd_main() Traceback (most recent call last): File "C:\python3.8.6\lib\runpy.py", line 185, in _run_module_as_main mod_name, mod_spec, code = _get_module_details(mod_name, _Error) File "C:\python3.8.6\lib\runpy.py", line 111, in _get_module_details import(pkg_name) File "C:\python3.8.6\lib\site-packages\earwax__init__.py", line 47, in from . import hat_directions, story, types, utils File "C:\python3.8.6\lib\site-packages\earwax\story__init__.py", line 31, in from .context import StoryContext File "C:\python3.8.6\lib\site-packages\earwax\story\context.py", line 12, in from ..editor import Editor File "C:\python3.8.6\lib\site-packages\earwax\editor.py", line 15, in from .level import Level File "C:\python3.8.6\lib\site-packages\earwax\level.py", line 11, in from .sound import AlreadyDestroyed, Sound, SoundManager File "C:\python3.8.6\lib\site-packages\earwax\sound.py", line 19, in from synthizer import (Buffer, BufferGenerator, Context, DirectSource, ImportError: cannot import name 'GlobalFdnReverb' from 'synthizer' (C:\python3.8.6\lib\site-packages\synthizer.cp38-win_amd64.pyd)

I don't want to open a new issue on this because I am not even sure if I am running this correctly. To clarify, I did update my version of earwax and synthesizer to the latest versions. I am running python 3.8.6. A getting started tutorial would go a long way in describing what needs to be done here and what the expected output is.

I like the idea of the library you are creating, it just feels like you are still working out some kinks.

Thanks,

Timothy Breitenfeldt

chrisnorman7 commented 3 years ago

Hi, Thanks for getting in touch, and I'm sorry (although not unsurprised) that you're still experiencing the same frustrations you had before.

I'm going to read your email when I'm a lot less tired, but wanted you to know wasn't ignoring you, especially if you're watching commits to Earwax.

Firstly, the command line client doesn't do a whole lot of much yet, apart from stories. I should have written into the docs though that you can start the CLI by just typing "earwax". I'll go make that change now.

A getting started tutorial is a great idea, and I'll definitely work on something like that when the tooling is a little more stable. Despite the stupidly high version number, it shouldn't really be at v1 yet, but I'm kind of feeling my way as it were.

Any and all feedback is useful, so please keep it coming.

Take care,

Chris Norman

On Sun, 17 Jan 2021 at 20:39, tbreitenfeldt notifications@github.com wrote:

Hi, I decided I would take a look at your library again for building an audio game, and found like last time there is no quick and easy way of getting up and going with this library.

I would like to propose a new tutorial that is linked to from your github readme for getting started with earwax. In the getting started, you can include your process for setting up a project using the earwax command line tools, and walking through creating a basic game using the tools that earwax provides. This would make it a lot easier for people new to earwax to get started using the library without having to read a bunch of documentation and example code.

I see you have a couple tutorials already on various features of earwax, so it shouldn't be to dificult to write up a getting started guide.

I was trying to run the commandline tool for running the earwax cli tools, although the docs on this is sparce, and I was not exactly sure what I needed to do. All that is provided in the docs is earwax.cmd.cmd_main() along with a couple other function calls. This is not how I am used to running python command line tools. Usually it is a separate executable or bat file that is in the scripts folder. I was not sure how to turn this, so I tried py -m earwax.cmd.cmd_main() and got an exception:

C:\Users\timot\Documents>py -m earwax.cmd.cmd_main() Traceback (most recent call last): File "C:\python3.8.6\lib\runpy.py", line 185, in _run_module_as_main mod_name, mod_spec, code = _get_module_details(mod_name,

Error) File "C:\python3.8.6\lib\runpy.py", line 111, in get_module_details import(pkg_name) File "C:\python3.8.6\lib\site-packages\earwax_init.py", line 47, in from . import hat_directions, story, types, utils File "C:\python3.8.6\lib\site-packages\earwax\story_init.py", line 31, in from .context import StoryContext File "C:\python3.8.6\lib\site-packages\earwax\story\context.py", line 12, in from ..editor import Editor File "C:\python3.8.6\lib\site-packages\earwax\editor.py", line 15, in from .level import Level File "C:\python3.8.6\lib\site-packages\earwax\level.py", line 11, in from .sound import AlreadyDestroyed, Sound, SoundManager File "C:\python3.8.6\lib\site-packages\earwax\sound.py", line 19, in from synthizer import (Buffer, BufferGenerator, Context, DirectSource, ImportError: cannot import name 'GlobalFdnReverb' from 'synthizer' (C:\python3.8.6\lib\site-packages\synthizer.cp38-win_amd64.pyd)

I don't want to open a new issue on this because I am not even sure if I am running this correctly. To clarify, I did update my version of earwax and synthesizer to the latest versions. I am running python 3.8.6. A getting started tutorial would go a long way in describing what needs to be done here and what the expected output is.

I like the idea of the library you are creating, it just feels like you are still working out some kinks.

Thanks,

Timothy Breitenfeldt

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/chrisnorman7/earwax/issues/1, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABBUZ2KZBLXQ3IQHIX722RLS2NDI3ANCNFSM4WGMKHNQ .

chrisnorman7 commented 3 years ago

I meant to say in my last email, your traceback is actually due to you not having a new enough version of Synthizer.

I've just added version constraints to Earwax, so that should now be taken care of, and you can try the earwax command again.

Take care,

Chris Norman

On Sun, 17 Jan 2021 at 20:39, tbreitenfeldt notifications@github.com wrote:

Hi, I decided I would take a look at your library again for building an audio game, and found like last time there is no quick and easy way of getting up and going with this library.

I would like to propose a new tutorial that is linked to from your github readme for getting started with earwax. In the getting started, you can include your process for setting up a project using the earwax command line tools, and walking through creating a basic game using the tools that earwax provides. This would make it a lot easier for people new to earwax to get started using the library without having to read a bunch of documentation and example code.

I see you have a couple tutorials already on various features of earwax, so it shouldn't be to dificult to write up a getting started guide.

I was trying to run the commandline tool for running the earwax cli tools, although the docs on this is sparce, and I was not exactly sure what I needed to do. All that is provided in the docs is earwax.cmd.cmd_main() along with a couple other function calls. This is not how I am used to running python command line tools. Usually it is a separate executable or bat file that is in the scripts folder. I was not sure how to turn this, so I tried py -m earwax.cmd.cmd_main() and got an exception:

C:\Users\timot\Documents>py -m earwax.cmd.cmd_main() Traceback (most recent call last): File "C:\python3.8.6\lib\runpy.py", line 185, in _run_module_as_main mod_name, mod_spec, code = _get_module_details(mod_name,

Error) File "C:\python3.8.6\lib\runpy.py", line 111, in get_module_details import(pkg_name) File "C:\python3.8.6\lib\site-packages\earwax_init.py", line 47, in from . import hat_directions, story, types, utils File "C:\python3.8.6\lib\site-packages\earwax\story_init.py", line 31, in from .context import StoryContext File "C:\python3.8.6\lib\site-packages\earwax\story\context.py", line 12, in from ..editor import Editor File "C:\python3.8.6\lib\site-packages\earwax\editor.py", line 15, in from .level import Level File "C:\python3.8.6\lib\site-packages\earwax\level.py", line 11, in from .sound import AlreadyDestroyed, Sound, SoundManager File "C:\python3.8.6\lib\site-packages\earwax\sound.py", line 19, in from synthizer import (Buffer, BufferGenerator, Context, DirectSource, ImportError: cannot import name 'GlobalFdnReverb' from 'synthizer' (C:\python3.8.6\lib\site-packages\synthizer.cp38-win_amd64.pyd)

I don't want to open a new issue on this because I am not even sure if I am running this correctly. To clarify, I did update my version of earwax and synthesizer to the latest versions. I am running python 3.8.6. A getting started tutorial would go a long way in describing what needs to be done here and what the expected output is.

I like the idea of the library you are creating, it just feels like you are still working out some kinks.

Thanks,

Timothy Breitenfeldt

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/chrisnorman7/earwax/issues/1, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABBUZ2KZBLXQ3IQHIX722RLS2NDI3ANCNFSM4WGMKHNQ .

tbreitenfeldt commented 3 years ago

Hi, no worries. I understand it is hard to maintain a library of medium size by yourself. I think there is a lot of good stuff in earwax, that lucia does not have yet.

Keep it up. The blind community needs more audio game tooling.

Thanks for the tip about versioning, I will give that a try.

On 1/18/21, Chris Norman notifications@github.com wrote:

I meant to say in my last email, your traceback is actually due to you not

having a new enough version of Synthizer.

I've just added version constraints to Earwax, so that should now be taken

care of, and you can try the earwax command again.

Take care,

Chris Norman

On Sun, 17 Jan 2021 at 20:39, tbreitenfeldt notifications@github.com

wrote:

Hi, I decided I would take a look at your library again for building an

audio game, and found like last time there is no quick and easy way of

getting up and going with this library.

I would like to propose a new tutorial that is linked to from your github

readme for getting started with earwax. In the getting started, you can

include your process for setting up a project using the earwax command line

tools, and walking through creating a basic game using the tools that

earwax provides. This would make it a lot easier for people new to earwax

to get started using the library without having to read a bunch of

documentation and example code.

I see you have a couple tutorials already on various features of earwax,

so it shouldn't be to dificult to write up a getting started guide.

I was trying to run the commandline tool for running the earwax cli tools,

although the docs on this is sparce, and I was not exactly sure what I

needed to do. All that is provided in the docs is

earwax.cmd.cmd_main()

along with a couple other function calls. This is not how I am used to

running python command line tools. Usually it is a separate executable or

bat file that is in the scripts folder. I was not sure how to turn this, so

I tried

py -m earwax.cmd.cmd_main()

and got an exception:

C:\Users\timot\Documents>py -m earwax.cmd.cmd_main()

Traceback (most recent call last):

File "C:\python3.8.6\lib\runpy.py", line 185, in _run_module_as_main

mod_name, mod_spec, code = _get_module_details(mod_name,

*Error) File "C:\python3.8.6\lib\runpy.py", line 111, in

get_module_details import(pkg_name) File

"C:\python3.8.6\lib\site-packages\earwax_init.py", line 47, in from .

import hat_directions, story, types, utils File

"C:\python3.8.6\lib\site-packages\earwax\story_init*.py", line 31, in

from .context import StoryContext

File "C:\python3.8.6\lib\site-packages\earwax\story\context.py", line 12,

in

from ..editor import Editor

File "C:\python3.8.6\lib\site-packages\earwax\editor.py", line 15, in

from .level import Level

File "C:\python3.8.6\lib\site-packages\earwax\level.py", line 11, in

from .sound import AlreadyDestroyed, Sound, SoundManager

File "C:\python3.8.6\lib\site-packages\earwax\sound.py", line 19, in

from synthizer import (Buffer, BufferGenerator, Context, DirectSource,

ImportError: cannot import name 'GlobalFdnReverb' from 'synthizer'

(C:\python3.8.6\lib\site-packages\synthizer.cp38-win_amd64.pyd)

I don't want to open a new issue on this because I am not even sure if I

am running this correctly. To clarify, I did update my version of earwax

and synthesizer to the latest versions. I am running python 3.8.6. A

getting started tutorial would go a long way in describing what needs to be

done here and what the expected output is.

I like the idea of the library you are creating, it just feels like you

are still working out some kinks.

Thanks,

Timothy Breitenfeldt

You are receiving this because you are subscribed to this thread.

Reply to this email directly, view it on GitHub

https://github.com/chrisnorman7/earwax/issues/1, or unsubscribe

https://github.com/notifications/unsubscribe-auth/ABBUZ2KZBLXQ3IQHIX722RLS2NDI3ANCNFSM4WGMKHNQ

.

--

You are receiving this because you authored the thread.

Reply to this email directly or view it on GitHub:

https://github.com/chrisnorman7/earwax/issues/1#issuecomment-762248640

--

Timothy Breitenfeldt

Phone: 509-388-7262

Skype: timothyjb310@outlook.com

https://www.linkedin.com/in/timothybreitenfeldt/

chrisnorman7 commented 3 years ago

To be fair, Lucia also has much less code. Thanks for the support though.

I'm working on a getting started guide now.

For your reference, the command earwax game main.py will write a basic game to main.py. That's the sumation of getting started so far haha.

chrisnorman7 commented 3 years ago

The new guide should appear here.

Have a look over it, and reopen this issue if anything looks amiss.

Thanks for your contributions, it's very much appreciated.