Merge branch 'ai16z:main' into main

.env.example

@@ -28,8 +28,8 @@ XAI_MODEL=
 # For asking Claude stuff
 ANTHROPIC_API_KEY=
 
-WALLET_SECRET_KEY=2eETRBeJFNfxAmPzTxfRynebRjTYK9WBLeAE5JhfxdzAxjJG8ZCbmHX1WadTRdcEpE7HRELVp6cbCfZFY6Qw9BgR
-WALLET_PUBLIC_KEY=DM1fSD9KfdJ2jaSmR9NGpPPVcDzBwsYg1STttYc5Bvay
+WALLET_SECRET_KEY=EXAMPLE_WALLET_SECRET_KEY
+WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
 
 BIRDEYE_API_KEY=
 

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing to Eliza
+
+First off, thank you for considering contributing to Eliza! It's people like you that make Eliza such a great tool. We welcome contributions from everyone, regardless of their experience level.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+1. Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ai16z/eliza/issues).
+2. If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ai16z/eliza/issues/new). Be sure to include
+
+- a title and clear description,
+- as much relevant information as possible, and
+- a code sample or an executable test case demonstrating the expected behavior that is not occurring.
+
+### Suggesting Enhancements
+
+1. Open a new issue with a clear title and detailed description of the suggested enhancement.
+2. Include any relevant examples or mock-ups if applicable.
+
+### Pull Requests
+
+1. Fork the repo and create your branch from `main`.
+    1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
+    1. eg. 40--add-test-for-bug-123
+2. If you've added code that should be tested, add tests.
+3. Ensure the test suite passes.
+4. Make sure your code lints.
+5. Issue that pull request!
+
+## Styleguides
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### JavaScript Styleguide
+
+- All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/).
+
+### TypeScript Styleguide
+
+- All TypeScript must adhere to [TypeScript Standard Style](https://github.com/standard/ts-standard).
+
+### Documentation Styleguide
+
+- Use [Markdown](https://daringfireball.net/projects/markdown/) for documentation.
+
+## Additional Notes
+
+### Issue and Pull Request Labels
+
+This section lists the labels we use to help us track and manage issues and pull requests.
+
+- `bug` - Issues that are bugs.
+- `enhancement` - Issues that are feature requests.
+- `documentation` - Issues or pull requests related to documentation.
+- `good first issue` - Good for newcomers.
+
+## Recognition
+
+We value every contribution. Contributors will be recognized in our README.md file. Significant contributions may be acknowledged with special roles or responsibilities within the project.
+
+## Questions?
+
+If you have any questions, please feel free to contact the project maintainers with an issue or in discord.
+
+Thank you for your interest in contributing to Eliza!

README.md

@@ -26,7 +26,7 @@ https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
 
 ## Edit the character file
 - Check out the file `src/core/defaultCharacter.ts` - you can modify this
-- You can also load characters with the `--charaters=<path>` and run multiple bots at the same time.
+- You can also load characters with the `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` and run multiple bots at the same time.
 
 ### Linux Installation
 You might need these
@@ -75,7 +75,7 @@ TWITTER_COOKIES= # Account cookies
 If you have an NVIDIA GPU, you can install CUDA to speed up local inference dramatically.
 ```
 npm install
-npx --no node-llama-cpp download --gpu cuda
+npx --no node-llama-cpp source download --gpu cuda
 ```
 
 Make sure that you've installed the CUDA Toolkit, including cuDNN and cuBLAS.