|
| 1 | +# @elizaos/plugin-swipr |
| 2 | + |
| 3 | +A plugin providing core functionality and basic actions for ElizaOS agents. |
| 4 | + |
| 5 | +## Description |
| 6 | + |
| 7 | +The Bootstrap plugin enables fundamental agent behaviors including conversation management, room interactions, and fact tracking. It provides essential actions and evaluators that form the foundation of agent interactions. |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +```bash |
| 12 | +pnpm install @elizaos/plugin-bootstrap |
| 13 | +``` |
| 14 | + |
| 15 | +## Features |
| 16 | + |
| 17 | +### 1. Conversation Management |
| 18 | + |
| 19 | +- NONE action for basic responses |
| 20 | +- CONTINUE action for follow-ups |
| 21 | +- IGNORE action for appropriate disengagement |
| 22 | +- Built-in conversation flow control |
| 23 | + |
| 24 | +### 2. Room Control |
| 25 | + |
| 26 | +- Follow/Unfollow room functionality |
| 27 | +- Mute/Unmute capabilities |
| 28 | +- Automatic engagement level tracking |
| 29 | +- Smart participation management |
| 30 | + |
| 31 | +### 3. Fact Management |
| 32 | + |
| 33 | +- Automatic fact extraction |
| 34 | +- Categorization of claims |
| 35 | +- Deduplication of known information |
| 36 | +- Support for multiple fact types: |
| 37 | + - Permanent facts |
| 38 | + - Status updates |
| 39 | + - Opinions |
| 40 | + - Biographical information |
| 41 | + |
| 42 | +### 4. Goal Tracking |
| 43 | + |
| 44 | +- Track objective progress |
| 45 | +- Update goal statuses |
| 46 | +- Monitor completion states |
| 47 | +- Automatic progress evaluation |
| 48 | + |
| 49 | +## Providers |
| 50 | + |
| 51 | +### 1. Boredom Provider |
| 52 | + |
| 53 | +- Tracks engagement levels |
| 54 | +- Provides status messages |
| 55 | +- Monitors conversation quality |
| 56 | +- Adjusts participation accordingly |
| 57 | + |
| 58 | +### 2. Facts Provider |
| 59 | + |
| 60 | +- Manages fact database |
| 61 | +- Retrieves relevant information |
| 62 | +- Formats fact summaries |
| 63 | +- Maintains fact context |
| 64 | + |
| 65 | +### 3. Time Provider |
| 66 | + |
| 67 | +- Provides UTC timestamps |
| 68 | +- Human-readable formatting |
| 69 | +- Time-based operation support |
| 70 | + |
| 71 | +## Development |
| 72 | + |
| 73 | +1. Clone the repository |
| 74 | +2. Install dependencies: |
| 75 | + |
| 76 | +```bash |
| 77 | +pnpm install |
| 78 | +``` |
| 79 | + |
| 80 | +3. Build the plugin: |
| 81 | + |
| 82 | +```bash |
| 83 | +pnpm run build |
| 84 | +``` |
| 85 | + |
| 86 | +4. Run linting: |
| 87 | + |
| 88 | +```bash |
| 89 | +pnpm run lint |
| 90 | +``` |
| 91 | + |
| 92 | +## Dependencies |
| 93 | + |
| 94 | +- @elizaos/core: workspace:\* |
| 95 | + |
| 96 | +## Future Enhancements |
| 97 | + |
| 98 | +1. **Enhanced Conversation Management** |
| 99 | + |
| 100 | + - Advanced context tracking |
| 101 | + - Multi-thread conversation support |
| 102 | + - Conversation state persistence |
| 103 | + - Improved conversation flow control |
| 104 | + - Natural language understanding improvements |
| 105 | + |
| 106 | +2. **Advanced Room Control** |
| 107 | + |
| 108 | + - Dynamic room creation and management |
| 109 | + - Room permission system |
| 110 | + - Advanced moderation tools |
| 111 | + - Room analytics and insights |
| 112 | + - Cross-room communication features |
| 113 | + |
| 114 | +3. **Expanded Fact Management** |
| 115 | + |
| 116 | + - Enhanced fact verification system |
| 117 | + - Fact relationship mapping |
| 118 | + - Automated fact updating |
| 119 | + - Fact confidence scoring |
| 120 | + - Cross-reference system |
| 121 | + - Fact expiration management |
| 122 | + |
| 123 | +4. **Goal System Improvements** |
| 124 | + |
| 125 | + - Multi-step goal planning |
| 126 | + - Goal dependency tracking |
| 127 | + - Progress visualization |
| 128 | + - Goal priority management |
| 129 | + - Automated milestone tracking |
| 130 | + - Goal optimization suggestions |
| 131 | + |
| 132 | +5. **Provider Enhancements** |
| 133 | + |
| 134 | + - Improved boredom detection |
| 135 | + - Advanced engagement metrics |
| 136 | + - Enhanced fact retrieval algorithms |
| 137 | + - Real-time status updates |
| 138 | + - Provider performance analytics |
| 139 | + |
| 140 | +6. **Memory Management** |
| 141 | + |
| 142 | + - Enhanced memory prioritization |
| 143 | + - Memory compression techniques |
| 144 | + - Long-term memory storage |
| 145 | + - Memory relationship mapping |
| 146 | + - Context-aware recall |
| 147 | + |
| 148 | +7. **Developer Tools** |
| 149 | + |
| 150 | + - Enhanced debugging capabilities |
| 151 | + - Testing framework improvements |
| 152 | + - Plugin development templates |
| 153 | + - Documentation generator |
| 154 | + - Performance profiling tools |
| 155 | + |
| 156 | +8. **Integration Features** |
| 157 | + - Enhanced plugin interoperability |
| 158 | + - External service connectors |
| 159 | + - API gateway integration |
| 160 | + - Webhook system improvements |
| 161 | + - Third-party platform support |
| 162 | + |
| 163 | +We welcome community feedback and contributions to help prioritize these enhancements. |
| 164 | + |
| 165 | +## Contributing |
| 166 | + |
| 167 | +Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information. |
| 168 | + |
| 169 | +## Credits |
| 170 | + |
| 171 | +Special thanks to: |
| 172 | + |
| 173 | +- The Eliza Core development team |
| 174 | +- The Eliza community for their contributions and feedback |
| 175 | + |
| 176 | +## License |
| 177 | + |
| 178 | +This plugin is part of the Eliza project. See the main project repository for license information. |
0 commit comments